From 69902bb0f0c5c15f9caff93a73737cbaba9ce133 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Tue, 13 Aug 2013 21:29:13 -0400 Subject: [PATCH] website: document the inspect command --- .../docs/command-line/inspect.html.markdown | 44 +++++++++++++++++++ website/source/layouts/docs.erb | 1 + 2 files changed, 45 insertions(+) create mode 100644 website/source/docs/command-line/inspect.html.markdown diff --git a/website/source/docs/command-line/inspect.html.markdown b/website/source/docs/command-line/inspect.html.markdown new file mode 100644 index 000000000..dab659ac7 --- /dev/null +++ b/website/source/docs/command-line/inspect.html.markdown @@ -0,0 +1,44 @@ +--- +layout: "docs" +page_title: "Inspect - Command-Line" +--- + +# Command-Line: Inspect + +The `packer inspect` command takes a template and outputs the various components +a template defines. This can help you quickly learn about a template without +having to dive into the JSON itself. +The command will tell you things like what variables a template accepts, +the builders it defines, the provisioners it defines and the order they'll +run, and more. + +This command is extra useful when used with +[machine-readable output](/docs/command-line/machine-readable.html) enabled. +The command outputs the components in a way that is parseable by machines. + +The command doesn't validate the actual configuration of the various +components (that is what the `validate` command is for), but it will +validate the syntax of your template by necessity. + +## Usage Example + +Given a basic template, here is an example of what the output might +look like: + +``` +$ packer inspect template.json +Variables and their defaults: + + aws_access_key = + aws_secret_key = + +Builders: + + amazon-ebs + amazon-instance + virtualbox + +Provisioners: + + shell +``` diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 2ab4b4a8e..4db164706 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -12,6 +12,7 @@
  • Introduction
  • Build
  • Fix
  • +
  • Inspect
  • Validate
  • Machine-Readable Output