github.com/kardianos/nomad@v0.1.3-0.20151022182107-b13df73ee850/website/source/docs/commands/index.html.md.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands (CLI)"
     4  sidebar_current: "docs-commands"
     5  description: >
     6    Nomad can be controlled via a command-line interface. This page documents all
     7    the commands Nomad accepts.
     8  ---
     9  
    10  # Nomad Commands (CLI)
    11  
    12  Nomad is controlled via a very easy to use command-line interface (CLI).
    13  Nomad is only a single command-line application: `nomad`, which 
    14  takes a subcommand such as "agent" or "status". The complete list of
    15  subcommands is in the navigation to the left.
    16  
    17  The Nomad CLI is a well-behaved command line application. In erroneous cases,
    18  a non-zero exit status will be returned. It also responds to `-h` and `--help`
    19  as you would most likely expect.
    20  
    21  To view a list of the available commands at any time, just run Nomad
    22  with no arguments. To get help for any specific subcommand, run the subcommand
    23  with the `-h` argument.
    24  
    25  Each command has been conveniently documented on this website. Links to each
    26  command can be found on the left.
    27  
    28  ### Command Contexts
    29  
    30  Nomad's CLI commands have implied contexts in their naming convention. Because
    31  the CLI is most commonly used to manipulate or query jobs, you can assume that
    32  any given command is working in that context unless the command name implies
    33  otherwise.
    34  
    35  For example, the `nomad run` command is used to run a new job, the `nomad
    36  status` command queries information about existing jobs, etc. Conversely,
    37  commands with a prefix in their name likely operate in a different context.
    38  Examples include the `nomad agent-status` or `nomad node-drain` commands,
    39  which operate in the agent or node contexts respectively.