README.md

Bolt

Bolt is a Ruby command-line tool for executing commands, scripts, and tasks on remote systems using SSH and WinRM.

• Executes commands on remote *nix and Windows systems.
• Distributes and execute scripts, such as Bash, PowerShell, Python.
• Scales to more than 1000 concurrent connections.
• Supports industry standard protocols (SSH/SCP, WinRM/PSRP) and authentication methods (password, publickey).

For a step-by-step introduction to Bolt, see our hands-on-lab.

Additionally the Bolt project includes:

• bolt-server, an experimental HTTP API for executing tasks over SSH and WinRM.
• bolt-inventory-pdb, a command-line tool for generating an inventory file from a template containing PuppetDB queries.

Installing bolt from a gem is not recommended since core modules will not be available. Please install bolt as a package

Supported platforms

• Linux, OSX, Windows
• Ruby 2.3+

For complete usage and installation details, see the Puppet Bolt docs.

For contributing information, including alternate installation methods and running from source code, see CONTRIBUTING.md.

• Install
• Bolt Commands
• Configure
  • Node-specific Configuration with the Inventory File
  • Connect to PuppetDB
• Puppet Tasks and Plans
  • Inspecting Tasks and Plans
  • Running Tasks
  • Running Plans
  • Installing Tasks and Plans
  • Writing Tasks
  • Writing Plans
• Applying Manifest Blocks in Plans

Getting Help

• #bolt on Slack - Join the Bolt developers and community

Kudos

Thank you to Marcin Bunsch for allowing Puppet to use the bolt gem name.

Contributing

We welcome error reports and pull requests to Bolt. See CONTRIBUTING.md for how to help.

License

The gem is available as open source under the terms of the Apache 2.0.