grim/convey

f7f74b4c31db
Parents e3a4b310eb72
Children d4f80bb35ed0
Update the usage in the readme. Refs #153
  • +37 -14
    README.md
  • --- a/README.md Sun Jan 07 22:10:25 2018 -0600
    +++ b/README.md Sun Jan 07 22:12:34 2018 -0600
    @@ -35,10 +35,10 @@
    # Usage
    - usage: convey [<flags>] [<plan>...]
    -
    - container runner
    -
    + usage: convey [<flags>] <command> [<args> ...]
    +
    + Convey is a container pipeline runner.
    +
    Flags:
    --help Show context-sensitive help (also try --help-long and --help-man).
    --version Show application version.
    @@ -50,19 +50,42 @@
    Location of docker client config files
    -e, --env=ENV ... Set environment variables
    -S, --force-sequential Don't run anything concurrently
    - -g, --graphviz Output a graphviz diagram of the config file
    - -L, --list-tasks List the supported tasks
    - -M, --list-meta-plans List the meta plans that are available
    - -P, --list-plans List the plans that are available
    - -m, --memory=MEMORY The ammount of memor to give the run task
    - --ssh-agent Enabled ssh-agent support for tasks
    + -m, --memory=MEMORY The amount of memory to give the run task
    + --ssh-agent A shortcut for --ssh-identity=*
    --ssh-identity=SSH-IDENTITY ...
    Enable ssh-agent for the given identities
    - --timeout=15m The maximum amount of time a task can run in seconds. 0 to disable
    + --timeout=15m The maximum amount of time a plan can run. 0 to disable. Units must be
    + specified.
    -v, --verbose Be more verbose
    -
    - Args:
    - [<plan>] The plan or list of plans to run in specified order
    + --disable-deprecated Allow the user of deprecated features
    +
    + Commands:
    + help [<command>...]
    + Show help.
    +
    + config
    + Show a dump of the config file
    +
    + environment
    + List the environment variables that are available
    +
    + graphviz
    + Output a graphviz diagram of the config file
    +
    + run* [<plan>...]
    + Run a plan or metaplan
    +
    + list environment
    + List the environment variables that are available.
    +
    + list metaplans
    + List the metaplans defined in the configuration file.
    +
    + list plans
    + List the plans defined in the configuration file.
    +
    + list tasks
    + List the tasks defined in the configuration file.
    # Configuration