Cloud Command

The cloud command is the one to use for provisioning and accessing your production infrastructure.

cloud

Usage: cloud [OPTIONS] COMMAND [ARGS]...

  Manage your remote servers and datacenters

Options:
  -v, --verbose    Make commands verbose, use multiple time for higher
                   verbosity
  --log-file TEXT  When using the verbose flag, redirects output to this file
  -h, --help       Show this message and exit.

Commands:
  inventory     Manage inventories
  job           Run maintenance jobs on remote servers.
  organization  Manage organizations
  provision     Provision remote servers.
  rsync         Sync files between your local machine and...
  run           Run shell command on multiple remote servers.
  shell         Open a shell on multiple remote servers.
  ssh           Connect to a remote server.
  update        Update AerisCloud
  version       See the aeriscloud version information

cloud inventory

Usage: cloud inventory [OPTIONS] COMMAND [ARGS]...

  Manage inventories

Options:
  -h, --help  Show this message and exit.

Commands:
  edit     Edit an inventory file.
  goto     Go to the inventory directory.
  install  Install inventories.
  list     List inventories.
  remove   Remove inventories.

cloud inventory edit

Usage: cloud inventory edit [OPTIONS] INVENTORY

  Edit an inventory file.

Options:
  --help  Show this message and exit.

cloud inventory goto

Usage: cloud inventory goto [OPTIONS] [INVENTORY_NAME]

  Go to the inventory directory.

Options:
  --help  Show this message and exit.

cloud inventory install

Usage: cloud inventory install [OPTIONS] [NAME] [PATH]

  Install inventories.

Options:
  --help  Show this message and exit.

cloud inventory list

Usage: cloud inventory list [OPTIONS]

  List inventories.

Options:
  --help  Show this message and exit.

cloud inventory remove

Usage: cloud inventory remove [OPTIONS] INVENTORY_NAME

  Remove inventories.

Options:
  --help  Show this message and exit.

cloud job

Usage: cloud job [OPTIONS] [JOB] [INVENTORY] [EXTRA]...

  Run maintenance jobs on remote servers.

Options:
  -h, --help  Show this message and exit.

cloud organization

Usage: cloud organization [OPTIONS] COMMAND [ARGS]...

  Manage organizations

Options:
  -h, --help  Show this message and exit.

Commands:
  goto     Go to the organization directory.
  init     Initialize a new organization.
  install  Install organization.
  list     List organizations.
  remove   Remove organizations.

cloud organization goto

Usage: cloud organization goto [OPTIONS] [ORGANIZATION_NAME]

  Go to the organization directory.

Options:
  --help  Show this message and exit.

cloud organization init

Usage: cloud organization init [OPTIONS] NAME [REPOSITORY]

      Initialize a new organization.

      The following usages are supported:

          cloud organization init <name> <git repository url>

      It will create a new AerisCloud organization and set the origin remote to
      the specified url.

      If the GitHub integration is enabled, you can also use the following
      commands:

          cloud organization init <github organization name>

      It will create a new AerisCloud organization and set the origin remote to
      git@github.com/<organization>/aeriscloud-organization.git

          cloud organization init <github organization name>/<project name>

      It will create a new AerisCloud organization and set the origin remote to
      git@github.com/<organization>/<project>-aeriscloud-organization.git

          cloud organization init <org name>/<customer>/<project name>

      It will create a new AerisCloud organization and set the origin remote to
      git@github.com/<organization>/<customer>-<project>-aeriscloud-organization.git

Options:
  --help  Show this message and exit.

cloud organization install

Usage: cloud organization install [OPTIONS] [NAME] [PATH]

  Install organization.

Options:
  --help  Show this message and exit.

cloud organization list

Usage: cloud organization list [OPTIONS]

  List organizations.

Options:
  --help  Show this message and exit.

cloud organization remove

Usage: cloud organization remove [OPTIONS] ORGANIZATION_NAME

  Remove organizations.

Options:
  --help  Show this message and exit.

cloud provision

Usage: cloud provision [OPTIONS] ENV INVENTORY [EXTRA]...

  Provision remote servers.

Options:
  -h, --help  Show this message and exit.

cloud rsync

Usage: cloud rsync [OPTIONS] INVENTORY SRC DEST [EXTRA]...

  Sync files between your local machine and remote servers.

Options:
  -h, --help  Show this message and exit.

cloud run

Usage: cloud run [OPTIONS] INVENTORY LIMIT [COMMAND]...

  Run shell command on multiple remote servers.

Options:
  -h, --help  Show this message and exit.

cloud shell

Usage: cloud shell [OPTIONS] INVENTORY [EXTRA]...

  Open a shell on multiple remote servers.

Options:
  -h, --help  Show this message and exit.

cloud ssh

Usage: cloud ssh [OPTIONS] INVENTORY HOST [EXTRA]...

  Connect to a remote server.

Options:
  --timeout INTEGER
  -h, --help         Show this message and exit.

cloud update

Usage: cloud update [OPTIONS]

  Update AerisCloud

Options:
  -f, --force  Force update
  -h, --help   Show this message and exit.

cloud version

Usage: cloud version [OPTIONS]

  See the aeriscloud version information

Options:
  --json
  -h, --help  Show this message and exit.