Bolt command reference

Sections

These subcommands, actions, and options are available for Bolt.

apply

Apply Puppet manifest code on the specified targets.

Usage

bolt apply [manifest.pp] [options]
OptionDescription
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on targets from the last run'all' all targets that were part of the last run.'failure' targets that failed in the last run.'success' targets that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password PASSWORDPassword to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPath to private ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password PASSWORDPassword for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
--[no-]cleanupWhether to clean up temporary files created on targets
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on targets that support it
--ssh-command EXECExecutable to use instead of the net-ssh ruby library. This option is experimental.
--copy-command EXECCommand to copy files to remote hosts if using external SSH. This option is experimental.
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--noopSee what changes Bolt will make without actually executing the changes
-e, --execute CODEPuppet manifest code to apply to the targets
--compile-concurrency CONCURRENCYMaximum number of simultaneous manifest block compiles (default: number of cores)
--hiera-config FILEPATHSpecify where to load Hiera config from (default: ~/.puppetlabs/bolt/hiera.yaml)

command run

Run a command on the specified targets.

Usage

bolt command run <command> [options]
OptionDescription
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on targets from the last run'all' all targets that were part of the last run.'failure' targets that failed in the last run.'success' targets that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password PASSWORDPassword to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPath to private ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password PASSWORDPassword for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
--[no-]cleanupWhether to clean up temporary files created on targets
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on targets that support it
--ssh-command EXECExecutable to use instead of the net-ssh ruby library. This option is experimental.
--copy-command EXECCommand to copy files to remote hosts if using external SSH. This option is experimental.
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging

file upload

Upload a local file or directory.

Usage

bolt file upload <src> <dest> [options]
OptionDescription
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on targets from the last run'all' all targets that were part of the last run.'failure' targets that failed in the last run.'success' targets that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password PASSWORDPassword to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPath to private ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password PASSWORDPassword for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
--[no-]cleanupWhether to clean up temporary files created on targets
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on targets that support it
--ssh-command EXECExecutable to use instead of the net-ssh ruby library. This option is experimental.
--copy-command EXECCommand to copy files to remote hosts if using external SSH. This option is experimental.
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--tmpdir DIRThe directory to upload and execute temporary files on the target

group show

Show the list of groups in the inventory.

Usage

bolt group show [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--format FORMATOutput format to use: human or json
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.

inventory show

Show the list of targets an action would run on.

Usage

bolt inventory show [options]
OptionDescription
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on targets from the last run'all' all targets that were part of the last run.'failure' targets that failed in the last run.'success' targets that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--format FORMATOutput format to use: human or json
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--detailShow resolved configuration for the targets

plan convert

Convert a YAML plan to a Bolt plan.

Converting a YAML plan may result in a plan that is syntactically correct but has different behavior. Always verify a converted plan's functionality.

Usage

bolt plan convert <path> [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.

plan run

Run a plan on the specified targets.

Usage

bolt plan run <plan> [parameters] [options]
OptionDescription
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on targets from the last run'all' all targets that were part of the last run.'failure' targets that failed in the last run.'success' targets that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password PASSWORDPassword to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPath to private ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password PASSWORDPassword for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
--[no-]cleanupWhether to clean up temporary files created on targets
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on targets that support it
--ssh-command EXECExecutable to use instead of the net-ssh ruby library. This option is experimental.
--copy-command EXECCommand to copy files to remote hosts if using external SSH. This option is experimental.
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--params PARAMETERSParameters to a task or plan as json, a json file '@<file>', or on stdin '-'
--compile-concurrency CONCURRENCYMaximum number of simultaneous manifest block compiles (default: number of cores)
--tmpdir DIRThe directory to upload and execute temporary files on the target
--hiera-config FILEPATHSpecify where to load Hiera config from (default: ~/.puppetlabs/bolt/hiera.yaml)

plan show

Show available plans and plan documentation.

Omitting the name of a plan will display a list of plans available in the Bolt project.

Providing the name of a plan will display detailed documentation for the plan, including a list of available parameters.

Usage

bolt plan show [plan] [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--filter FILTERFilter tasks and plans by a matching substring
--format FORMATOutput format to use: human or json

project init

Create a new Bolt project.

Specify a directory to create a Bolt project in. Defaults to the curent working directory.

Usage

bolt project init [directory] [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--modules MODULESA comma-separated list of modules to install from the Puppet Forgewhen initializing a project. Resolves and installs all dependencies.

project migrate

Migrate a Bolt project to the latest version.

Loads a Bolt project's inventory file and migrates it to the latest version. The inventory file is modified in place and will not preserve comments or formatting.

Usage

bolt project migrate [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.

puppetfile generate-types

Generate type references to register in plans.

Usage

bolt puppetfile generate-types [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.

puppetfile install

Install modules from a Puppetfile into a project

Usage

bolt puppetfile install [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--puppetfile FILEPATHSpecify a Puppetfile to use when installing modules. (default: ~/.puppetlabs/bolt/Puppetfile)Modules are installed in the current project.

puppetfile show-modules

List modules available to the Bolt project.

Usage

bolt puppetfile show-modules [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.

script run

Run a script on the specified targets.

Arguments passed to a script are passed literally and are not interpolated by the shell. Any arguments containing spaces or special characters should be quoted.

Usage

bolt script run <script> [arguments] [options]
OptionDescription
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on targets from the last run'all' all targets that were part of the last run.'failure' targets that failed in the last run.'success' targets that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password PASSWORDPassword to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPath to private ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password PASSWORDPassword for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
--[no-]cleanupWhether to clean up temporary files created on targets
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on targets that support it
--ssh-command EXECExecutable to use instead of the net-ssh ruby library. This option is experimental.
--copy-command EXECCommand to copy files to remote hosts if using external SSH. This option is experimental.
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--tmpdir DIRThe directory to upload and execute temporary files on the target

secret createkeys

Create new encryption keys.

Usage

bolt secret createkeys [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--plugin PLUGINSelect the plugin to use
--forceOverwrite existing key pairs

secret decrypt

Decrypt a value.

Usage

bolt secret decrypt <ciphertext> [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--plugin PLUGINSelect the plugin to use

secret encrypt

Encrypt a value.

Usage

bolt secret encrypt <plaintext> [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--plugin PLUGINSelect the plugin to use

task run

Run a task on the specified targets.

Parameters take the form parameter=value.

Usage

bolt task run <task> [parameters] [options]
OptionDescription
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on targets from the last run'all' all targets that were part of the last run.'failure' targets that failed in the last run.'success' targets that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password PASSWORDPassword to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPath to private ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password PASSWORDPassword for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
--[no-]cleanupWhether to clean up temporary files created on targets
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on targets that support it
--ssh-command EXECExecutable to use instead of the net-ssh ruby library. This option is experimental.
--copy-command EXECCommand to copy files to remote hosts if using external SSH. This option is experimental.
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--params PARAMETERSParameters to a task or plan as json, a json file '@<file>', or on stdin '-'
--tmpdir DIRThe directory to upload and execute temporary files on the target
--noopSee what changes Bolt will make without actually executing the changes

task show

Show available tasks and task documentation.

Omitting the name of a task will display a list of tasks available in the Bolt project.

Providing the name of a task will display detailed documentation for the task, including a list of available parameters.

Usage

bolt task show [task] [options]
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--project FILEPATHSpecify what project to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).Directory containing bolt.yaml will be used as the project directory.
--filter FILTERFilter tasks and plans by a matching substring
--format FORMATOutput format to use: human or json
See an issue? Please file a JIRA ticket in our [DOCUMENTATION] project
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.