search

projectatomic / atomicapp

[UNMAINTAINED] This is the reference implementation of the Nulecule container application Specification: Atomic App
102 stars 71 forks source link

add directory arg to atomicapp --help #582

Open jberkus opened 8 years ago

jberkus commented 8 years ago

Currently:

atomicapp --help
usage: atomicapp {run,fetch,stop,genanswers} ...

Should be:

atomicapp --help
usage: atomicapp {run,fetch,stop,genanswers} ... DIR

... since the directory of the atomicapp is an expected argument.

cdrage commented 8 years ago

Currently we have it like this with atomicapp run --help

dropbox/dev/atomicapp  master ✔                                                                                                                                                                                                                          1d  ⍉
▶ atomicapp run --help
usage: atomicapp run [-h] [-V] [-v] [-q] [--mode {fetch,run,stop,genanswers}]
                     [--dry-run] [--answers-format {ini,json,xml,yaml}]
                     [--namespace NAMESPACE]
                     [--providertlsverify {True,False}]
                     [--providerconfig PROVIDERCONFIG]
                     [--providercafile PROVIDERCAFILE]
                     [--providerapi PROVIDERAPI]
                     [--logtype {cockpit,color,nocolor,none}] [-a ANSWERS]
                     [--write-answers ANSWERS_OUTPUT]
                     [--provider {docker,kubernetes,openshift,marathon}]
                     [--ask] [--destination DESTINATION]
                     [app_spec]

positional arguments:
  app_spec              Application to run. This is a container image or a
                        path that contains the metadata describing the whole
                        application.

Should we add a similar "usage" example like above?