Command Line Usage

General options

usage: batou [-h] [-d] [-F] {deploy,secrets,init,update} ...

batou v1.2b1 multi-(host|component|environment|version|platform) deployment

positional arguments:
  {deploy,remote,secrets,init,update}
    deploy              Deploy an environment.
    secrets             Manage encrypted secret files. Relies on gpg being
                        installed and configured correctly.
    init                Initialize batou project in the given directory. If
                        the given directory does not exist, it will be
                        created. If no directory is given, the current
                        directory is used.
    update              Update the batou version.

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           Enable debug mode. (default: False)
  -F, --fast            Enable fast mode. Do not perform bootstrapping.
                        (default: False)
  --reset               Reset batou environment. (default: False)

batou deploy

usage: batou deploy [-h] [-p PLATFORM] [-t TIMEOUT] [-D] [-c] [-P] environment

positional arguments:
  environment           Environment to deploy.

optional arguments:
  -h, --help            show this help message and exit
  -p PLATFORM, --platform PLATFORM
                        Alternative platform to choose. Empty for no platform.
  -t TIMEOUT, --timeout TIMEOUT
                        Override the environment's timeout setting
  -D, --dirty           Allow deploying with dirty working copy or outgoing
                        changes.
  -c, --consistency-only
                        Only perform a deployment model and environment
                        consistency check. Only connects to a single host.
                        Does not touch anything.
  -P, --predict-only    Only predict what updates would happen. Do not change
                        anything.

batou secrets edit

usage: batou secrets edit [-h] [--editor EDITOR] environment

positional arguments:
  environment           Environment to edit secrets for.

optional arguments:
  -h, --help            show this help message and exit
  --editor EDITOR, -e EDITOR
                        Invoke EDITOR to edit (default: $EDITOR or vi)

batou secrets overview

Show an overview of which users have access to what encrypted secrets.

usage: batou secrets summary [-h]

optional arguments:
  -h, --help  show this help message and exit

batou secrets add

usage: batou secrets add [-h] [--environments ENVIRONMENTS] keyid

positional arguments:
  keyid                 The user's key ID or email address

optional arguments:
  -h, --help            show this help message and exit
  --environments ENVIRONMENTS
                        The environments to update. Update all if not
                        specified.

batou secrets remove

usage: batou secrets remove [-h] [--environments ENVIRONMENTS] keyid

positional arguments:
  keyid                 The user's key ID or email address

optional arguments:
  -h, --help            show this help message and exit
  --environments ENVIRONMENTS
                        The environments to update. Update all if not
                        specified.

batou update

usage: batou update [-h] (--version VERSION | --develop DEVELOP)

optional arguments:
  -h, --help         show this help message and exit
  --version VERSION  Exact version to install.
  --develop DEVELOP  Path to checkout of batou to install in edit mode.