Aeris Command

The aeris command is the main command you will use during development as it deals with the local environment and boxes. It is a wrapper around the vagrant and ansible commands that takes care for you of most of the cruft around those tools and bind them in a coherent package.

While the tool sports a large amount of commands, you will deal mainly with a small subset of them.

aeris

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

  Manage your local development environments

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:
  box        Manage base boxes
  browse     Open an endpoint in your default browser
  build      Build your native application
  config     Get and set your AerisCloud options
  destroy    Destroy a box
  expose     Manage project exposition
  fetch      Allows you to fetch a project from GitHub
  git        Run a git command
  goto       Goto a project's directory
  halt       Halt a box, can be started back using up
  history    Shows provisioning history for a box
  init       Initialize a new AerisCloud project
  job        Run a maintenance job in a box.
  make       Run a make command
  provision  Provision a box
  ssh        Launch a ssh shell on the box
  status     Query the status of boxes
  suspend    Suspend a running box, see resume
  sync       Sync data up or down
  up         Starts the given box and provision it
  update     Update AerisCloud
  version    See the aeriscloud version information
  watch      Sync files and restart your application upon...

aeris box

Usage: aeris box [OPTIONS] COMMAND [ARGS]...

  Manage base boxes

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

Commands:
  generate  Generate metadata for boxes (sysadmin tool)
  list      List the available base boxes

aeris box generate

Usage: aeris box generate [OPTIONS]

  Generate metadata for boxes (sysadmin tool)

Options:
  -j, --json       Output metadata as JSON
  -p, --path TEXT  Where to save the metadata files
  --help           Show this message and exit.

aeris box list

Usage: aeris box list [OPTIONS]

  List the available base boxes

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

aeris browse

Usage: aeris browse [OPTIONS] [ENDPOINT]

  Open an endpoint in your default browser

Options:
  -i, --ip                 Use the machine IP instead of the aeris.cd domain
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris build

Usage: aeris build [OPTIONS] SERVER PLATFORM

  Build your native application

Options:
  -v, --variable TEXT      Specify the variable you want to change
  -u, --unity TEXT         Path to your Unity directory
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris config

Usage: aeris config [OPTIONS] [OPTION] [VALUE]

  Get and set your AerisCloud options

Options:
  -a, --all    Show all options
  -u, --unset  Unset an option
  --raw
  -h, --help   Show this message and exit.

aeris destroy

Usage: aeris destroy [OPTIONS]

  Destroy a box

Options:
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris expose

Usage: aeris expose [OPTIONS] COMMAND [ARGS]...

  Manage project exposition

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

Commands:
  announce  Announce all the running services
  list      List the exposed projects
  start     Start the expose server
  status    Check the status of the expose server
  stop      Stop the expose server

aeris expose announce

Usage: aeris expose announce [OPTIONS]

  Announce all the running services

Options:
  --help  Show this message and exit.

aeris expose list

Usage: aeris expose list [OPTIONS]

  List the exposed projects

Options:
  -p, --project TEXT
  -i, --infra TEXT
  -b, --box TEXT
  --json
  --help              Show this message and exit.

aeris expose start

Usage: aeris expose start [OPTIONS]

  Start the expose server

Options:
  --help  Show this message and exit.

aeris expose status

Usage: aeris expose status [OPTIONS]

  Check the status of the expose server

Options:
  --help  Show this message and exit.

aeris expose stop

Usage: aeris expose stop [OPTIONS]

  Stop the expose server

Options:
  --help  Show this message and exit.

aeris fetch

Usage: aeris fetch [OPTIONS] <project>

  Allows you to fetch a project from GitHub

Options:
  --up          Start the box after fetching the project
  --make <cmd>  Run the given make command after booting up the box(will start
                it even if up is not set)
  --box <box>   Set the box to use for up or make
  -h, --help    Show this message and exit.

  Example:

  * To download a project and start the box:
  $ aeris fetch --up <project>

  * To download a project, start the box and run make all:
  $ aeris fetch --make all <project>

  * To download a project and select the box to start:
  $ aeris fetch --up --box <box> <project>

aeris git

Usage: aeris git [OPTIONS] [COMMAND]...

  Run a git command

Options:
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris goto

Usage: aeris goto [OPTIONS] [PROJECT]

  Goto a project's directory

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

aeris halt

Usage: aeris halt [OPTIONS]

  Halt a box, can be started back using up

Options:
  -p, --project [project]  Which project to use, by default usethe current
                           folder.
  -b, --box [box]          Which box to use, by default uses all the boxes
                           from the project.
  -a, --all                Target all boxes from all projects
  -h, --help               Show this message and exit.

aeris history

Usage: aeris history [OPTIONS]

  Shows provisioning history for a box

Options:
  -q, --quiet
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris init

Usage: aeris init [OPTIONS] [FOLDER]

  Initialize a new AerisCloud project

Options:
  -u, --up
  -m, --make <command>
  -b, --box TEXT        Which box to use for make
  -h, --help            Show this message and exit.

aeris job

Usage: aeris job [OPTIONS] [JOB] [EXTRA]...

  Run a maintenance job in a box.

  Call without a job to get the job list

Options:
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris make

Usage: aeris make [OPTIONS] [COMMAND]...

  Run a make command

Options:
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris provision

Usage: aeris provision [OPTIONS] [EXTRA]...

  Provision a box

Options:
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris ssh

Usage: aeris ssh [OPTIONS] [COMMAND]...

  Launch a ssh shell on the box

Options:
  --force                  Connect anyway if project server is not set
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris status

Usage: aeris status [OPTIONS]

  Query the status of boxes

Options:
  --show-all               Show boxes that are not created in virtualbox
  -p, --project [project]  Which project to use, by default usethe current
                           folder.
  -b, --box [box]          Which box to use, by default uses all the boxes
                           from the project.
  -a, --all                Target all boxes from all projects
  -h, --help               Show this message and exit.

aeris suspend

Usage: aeris suspend [OPTIONS]

  Suspend a running box, see resume

Options:
  -p, --project [project]  Which project to use, by default usethe current
                           folder.
  -b, --box [box]          Which box to use, by default uses all the boxes
                           from the project.
  -a, --all                Target all boxes from all projects
  -h, --help               Show this message and exit.

aeris sync

Usage: aeris sync [OPTIONS] [DIRECTION]

  Sync data up or down

Options:
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris up

Usage: aeris up [OPTIONS]

  Starts the given box and provision it

Options:
  --provision-with TEXT
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.

aeris update

Usage: aeris update [OPTIONS]

  Update AerisCloud

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

aeris version

Usage: aeris version [OPTIONS]

  See the aeriscloud version information

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

aeris watch

Usage: aeris watch [OPTIONS] [COMMAND]...

  Sync files and restart your application upon file changes

Options:
  -p, --project [project]  Which project to use, by defaultuse the current
                           folder.
  -b, --box [box]          Which box to use, by default uses the first
                           available.
  -h, --help               Show this message and exit.