diff --git a/website/source/docs/commands/plan.html.md.erb b/website/source/docs/commands/plan.html.md.erb index cafd38952..c000113a9 100644 --- a/website/source/docs/commands/plan.html.md.erb +++ b/website/source/docs/commands/plan.html.md.erb @@ -19,6 +19,14 @@ format. nomad plan [options] ``` +The plan command requires a single argument, specifying the path to a file +containing a [HCL job specification](/docs/jobspec/index.html). This file +will be read and the job checked for any problems. If the +supplied path is "-", the jobfile is read from STDIN. Otherwise it is read +from the file at the supplied path or downloaded and read from URL specified. +Nomad downloads jobfile using [`go-getter`](https://github.com/hashicorp/go-getter) +and support `go-getter` syntax. + Plan invokes a dry-run of the scheduler to determine the effects of submitting either a new or updated version of a job. The plan will not result in any changes to the cluster but gives insight into whether the job could be run