diff --git a/website/source/docs/command-line/validate.html.markdown b/website/source/docs/command-line/validate.html.markdown new file mode 100644 index 000000000..fcf992f1f --- /dev/null +++ b/website/source/docs/command-line/validate.html.markdown @@ -0,0 +1,26 @@ +--- +layout: "docs" +--- + +# Command-Line: Validate + +The `packer validate` command is used to validate the syntax and configuration +of a [template](/docs/templates/introduction.html). The command will return +a zero exit status on success, and a non-zero exit status on failure. Additionally, +if a template doesn't validate, any error messages will be outputted. + +Example usage: + +``` +$ packer validate my-template.json +Template validation failed. Errors are shown below. + +Errors validating build 'vmware'. 1 error(s) occurred: + +* Either a path or inline script must be specified. +``` + +## Options + +* `-syntax-only` - Only the syntax of the template is checked. The configuration + is not validated. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index a898bbe22..22ace5071 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -33,7 +33,7 @@
  • Introduction
  • Build
  • -
  • Validate
  • +
  • Validate
  • Introduction