Inspecting plans

Before you run a plan in your environment, inspect the plan to determine what effect it has on your targets.

🔩 Tip: Bolt is packaged with a collection of modules that contain useful plans to support common workflows. For details, see Packaged modules.

Discover plans

View a list of available plans:

*nix shell command
```
bolt plan show
```
PowerShell cmdlet
```
Get-BoltPlan
```

If you don't see a plan you were expecting to find, make sure the plan is located in the correct directory. For more information, see How Bolt locates plans

Show documentation for a plan

Use the following command to view parameters and other details for a plan, including whether a plan supports noop:

*nix shell command
```
bolt plan show <PLAN NAME>
```
PowerShell cmdlet
```
Get-BoltPlan -Name <PLAN NAME>
```

Was this page helpful?

We’re sorry to hear that!
Please tell us why so we can help. Enter your feedback and email. This form is sent to the Puppet docs team. We ask for your email as we might contact you regarding your feedback. If you need help with the product itself, visit Puppet Support or ask in Puppet Community on Slack. Feedback:

Email Address:

To learn about how Puppet uses your personal information, visit our privacy policy.

If you leave us your email, we may contact you regarding your feedback. For more information on how Puppet uses your personal information, see our privacy policy.

See an issue? Please file a JIRA ticket in our [DOCUMENTATION] project.