Usage

Convey is a terminal based application. It has a few subcommands, but it will primarily be called with the run subcommand.

Basic

Usage: convey <command>

Convey is a container pipeline runner.

Flags:
  -h, --help       Show context-sensitive help.
      --color      Enable colorized output.
  -v, --verbose    Be more verbose

Commands:
  run        Run plans
  version    Show the version and exit

Run "convey <command> --help" for more information on a command.

Run Command

Usage: convey run [<plans> ...]

Run plans

Arguments:
  [<plans> ...]    The names of the plans to run

Flags:
  -h, --help                Show context-sensitive help.
      --color               Enable colorized output.
  -v, --verbose             Be more verbose

  -f, --config-file=FILE    The config file to load
  -S, --force-sequential    Force concurrent stages to be ran sequentially
      --keep-workspace      Keep the workspace directory after running
      --timeout=DURATION    The maximum amount of time a plan can run. 0 to disable. Units must be
                            specified.
  -e, --env=ENV,...        Set an environment variable

Version Command

Usage: convey version

Show the version and exit

Flags:
  -h, --help       Show context-sensitive help.
      --color      Enable colorized output.
  -v, --verbose    Be more verbose