Execute commands remotely over SSH and WinRM
adreyer Merge pull request #722 from MikaelSmith/BOLT-926
(BOLT-926) Add implementations and files to task metadata reference
Latest commit 85cf0e9 Oct 19, 2018
Permalink
Failed to load latest commit information.
acceptance (BOLT-755) Add acceptance test Oct 9, 2018
bolt-modules/boltlib (BOLT-914) Clean up Bolt-as-a-library includes Oct 8, 2018
config (BOLT-916) Download task files from master and support shareable code Oct 17, 2018
developer-docs (BOLT-916) Download task files from master and support shareable code Oct 17, 2018
exe (maint) Switch to using Puma CLI to run bolt-server Aug 23, 2018
lib (BOLT-916) Remove ability accept file content from boltserver Oct 19, 2018
libexec (BOLT-898) Include agent facts in apply_prep Oct 5, 2018
locales (maint) Add gettext:update_pot Rake task Mar 15, 2018
modules (BOLT-748) Unvendor Puppet Oct 2, 2018
pre-docs (BOLT-926) Add implementations and files to task metadata reference Oct 19, 2018
resources (maint) Add simple bash completion (#506) Jul 10, 2018
scripts (BOLT-916) Download task files from master and support shareable code Oct 17, 2018
spec (BOLT-916) Remove ability accept file content from boltserver Oct 19, 2018
ux Updated file spec Nov 21, 2017
.dockerignore (maint) add Dockerfile for bolt-server Oct 11, 2018
.gitignore (BOLT-906) Include python_task_helper Oct 18, 2018
.rspec (TASKS-14) Add spec helper Aug 11, 2017
.rubocop.yml (maint) Fix rubocop 0.59 issues Sep 10, 2018
.travis.yml (BOLT-916) Download task files from master and support shareable code Oct 17, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Oct 10, 2017
CONTRIBUTING.md (maint) Add setup for running appveyor_agents tests locally Oct 16, 2018
Dockerfile (maint) add Dockerfile for bolt-server Oct 11, 2018
Gemfile (maint) add Dockerfile for bolt-server Oct 11, 2018
LICENSE Initial commit Aug 11, 2017
Puppetfile (BOLT-906) Include python_task_helper Oct 18, 2018
README.md (maint) Add notes about not installing bolt as a gem Sep 21, 2018
Rakefile (BOLT-916) Download task files from master and support shareable code Oct 17, 2018
Vagrantfile (maint) Add setup for running appveyor_agents tests locally Oct 16, 2018
appveyor.yml (maint) Skip Appveyor tests locally Oct 15, 2018
bolt.gemspec (maint) Include CFPropertyList gem Oct 17, 2018
docker-compose.yml (BOLT-916) Download task files from master and support shareable code Oct 17, 2018
puma_config.rb (BOLT-916) Download task files from master and support shareable code Oct 17, 2018

README.md

Bolt

Travis Status Appveyor Status Gem Version

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.

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.