packer/website/source/docs/provisioners/shell-local.html.md

description	layout	page_title	sidebar_current
shell-local will run a shell script of your choosing on the machine where Packer is being run - in other words, it shell-local will run the shell script on your build server, or your desktop, etc., rather than the remote/guest machine being provisioned by Packer.	docs	Shell (Local) - Provisioners	docs-provisioners-shell-local

Local Shell Provisioner

Type: shell-local

shell-local will run a shell script of your choosing on the machine where Packer is being run - in other words, it shell-local will run the shell script on your build server, or your desktop, etc., rather than the remote/guest machine being provisioned by Packer.

The remote shell provisioner executes shell scripts on a remote machine.

Basic Example

The example below is fully functional.

{
  "type": "shell-local",
  "command": "echo foo"
}

Configuration Reference

The reference of available configuration options is listed below. The only required element is "command".

Exactly one of the following is required:

• command (string) - This is a single command to execute. It will be written to a temporary file and run using the execute_command call below.

• inline (array of strings) - This is an array of commands to execute. The commands are concatenated by newlines and turned into a single file, so they are all executed within the same context. This allows you to change directories in one command and use something in the directory in the next and so on. Inline scripts are the easiest way to pull off simple tasks within the machine.

• script (string) - The path to a script to execute. This path can be absolute or relative. If it is relative, it is relative to the working directory when Packer is executed.

• scripts (array of strings) - An array of scripts to execute. The scripts will be executed in the order specified. Each script is executed in isolation, so state such as variables from one script won't carry on to the next.

Optional parameters:

• execute_command (array of strings) - The command to use to execute the script. By default this is ["/bin/sh", "-c", "{{.Command}}"]. The value is an array of arguments executed directly by the OS. The value of this is treated as configuration template. The only available variable is Command which is the command to execute.

• environment_vars (array of strings) - An array of key/value pairs to inject prior to the execute_command. The format should be key=value. Packer injects some environmental variables by default into the environment, as well, which are covered in the section below.

• execute_command (array of strings) - The command used to execute the script. By default this is ["/bin/sh", "-c", "{{.Vars}}, "{{.Script}}"] on unix and ["cmd", "/c", "{{.Vars}}", "{{.Script}}"] on windows. This is treated as a template engine. There are two available variables: Script, which is the path to the script to run, and Vars, which is the list of environment_vars, if configured If you choose to set this option, make sure that the first element in the array is the shell program you want to use (for example, "sh" or "/usr/local/bin/zsh" or even "powershell.exe" although anything other than a flavor of the shell command language is not explicitly supported and may be broken by assumptions made within Packer), and a later element in the array must be {{.Script}}.

  For backwards compatability, {{.Command}} is also available to use in execute_command but it is decoded the same way as {{.Script}}. We recommend using {{.Script}} for the sake of clarity, as even when you set only a single command to run, Packer writes it to a temporary file and then runs it as a script.

• inline_shebang (string) - The shebang value to use when running commands specified by inline. By default, this is /bin/sh -e. If you're not using inline, then this configuration has no effect. Important: If you customize this, be sure to include something like the -e flag, otherwise individual steps failing won't fail the provisioner.