Command line interface

Installation

The command line interface requires additional dependencies, which can be installed using pip. The program will be installed as jiffybox.

$ pip install jiffybox[cli]

For the complete documentation of the command line interface see the builtin help.

$ jiffybox --help
Usage:  [OPTIONS] COMMAND [ARGS]...

Options:
  --version                       Show the version and exit.
  --api-key TEXT                  also read from JIFFYBOX_API_KEY  [required]
  -v, --verbose
  --output-format [plain|json|json-pretty]
  --pager
  --help                          Show this message and exit.

Commands:
  box            Manages boxes
  distributions  Shows a list of distributions
  plans          Shows a list of pricing plans

$ jiffybox box --help
Usage:  [OPTIONS] COMMAND [ARGS]...

  Manages boxes

Options:
  --help  Show this message and exit.

Commands:
  create  Creates and start a new box
  delete  Deletes a box
  list    Lists all boxes in account
  show    Shows a single box

$ jiffybox box create --help
Usage:  [OPTIONS] NAME PLAN DISTRIBUTION

  Creates and start a new box

Options:
  --sshkey / --no-sshkey
  --help                  Show this message and exit.

$ jiffybox box delete --help
Usage:  [OPTIONS] ID

  Deletes a box

Options:
  --no-confirm
  -f, --force   Stop jiffybox if necessary
  --help        Show this message and exit.

$ jiffybox box list --help
Usage:  [OPTIONS]

  Lists all boxes in account

Options:
  -q, --quiet  Suppress warning at the start
  --help       Show this message and exit.

$ jiffybox box show --help
Usage:  [OPTIONS] ID

  Shows a single box

Options:
  --help  Show this message and exit.

$ jiffybox distributions --help
Usage:  [OPTIONS]

  Shows a list of distributions

Options:
  --help  Show this message and exit.

$ jiffybox plans --help
Usage:  [OPTIONS]

  Shows a list of pricing plans

Options:
  --help  Show this message and exit.