Packaged versions of Bolt are available for many modern Linux distributions, as well as macOS and Windows.

Have questions? Get in touch. We're in #bolt on the Puppet community Slack.

Tip: Bolt uses an internal version of Puppet that supports tasks and plans, so you do not need to install Puppet. If you use Bolt on a machine that has Puppet installed, then Bolt uses its internal version of Puppet and does not conflict with the Puppet version you have installed.
Note: Bolt automatically collects data about how you use it. If you want to opt out of providing this data, you can do so. For more information see, Analytics data collection

Install Bolt on Windows

Use one of the supported Windows installation methods to install Bolt.

Install Bolt with Chocolatey

Use the package manager Chocolatey to install Bolt on Windows.

Before you begin

You must have the Chocolatey package manager installed.

  1. Download and install the bolt package.
    choco install puppet-bolt
    
  2. Run a Bolt command and get started.
    bolt --help

Install Bolt on macOS

Use one of the supported macOS installation methods to install Bolt.

Install Bolt with macOS installer 

Use the Apple Disk Image (DMG) to install Bolt on macOS.

  1. Download the Bolt installer package for your macOS version.
    Tip: To find the macOS version number on your Mac, go to the Apple () menu in the corner of your screen and choose About This Mac.
  2. Double-click the puppet-bolt-latest.dmg file to mount it and then double-click the puppet-bolt-[version]-installer.pkg to run the installation.
  3. Run a Bolt command and get started.
    bolt --help

Install Bolt with Homebrew

Use the package manager Homebrew to install Bolt on macOS.

Before you begin

You must have the command line tools for macOS and the Homebrew package manager installed.

  1. Download and install the bolt package.
    brew cask install puppetlabs/puppet/puppet-bolt
    
  2. Run a Bolt command and get started.
    bolt --help

Install Bolt on *nix

Use one of the supported *nix installation methods to install Bolt.

Important: If you're installing Bolt on Puppet Enterprise nodes, consider downloading and installing the Bolt package directly from http://apt.puppet.com/ or http://yum.puppet.com/. This allows you to control the software versions in use on your systems, however, you must manually update Bolt as needed. The following instructions include enabling the Puppet platform repository. On PE master nodes, this method can result in unsupported updates to Puppet packages, such as the puppet agent.

Install Bolt on Debian or Ubuntu

Packaged versions of Bolt are available for Debian 8 and 9 and Ubuntu 14.04, 16.04 and 18.04.

The Puppet repository for the APT package management system is https://apt.puppet.com. Packages are named using the convention <PLATFORM_VERSION>-release-<VERSION CODE NAME>.deb. For example, the release package for Puppet 6 Platform on Debian 8 “Jessie” is puppet6-release-jessie.deb.

  1. Download and install the software and its dependencies. Use the commands appropriate to your system.
    • Debian 8
      wget https://apt.puppet.com/puppet6-release-jessie.deb
      sudo dpkg -i puppet6-release-jessie.deb
      sudo apt-get update 
      sudo apt-get install puppet-bolt
      
    • Debian 9
      wget https://apt.puppet.com/puppet6-release-stretch.deb
      sudo dpkg -i puppet6-release-stretch.deb
      sudo apt-get update 
      sudo apt-get install puppet-bolt
    • Ubuntu 14.04
      wget https://apt.puppet.com/puppet6-release-trusty.deb
      sudo dpkg -i puppet6-release-trusty.deb
      sudo apt-get update 
      sudo apt-get install puppet-bolt
    • Ubuntu 16.04
      wget https://apt.puppet.com/puppet6-release-xenial.deb
      sudo dpkg -i puppet6-release-xenial.deb
      sudo apt-get update 
      sudo apt-get install puppet-bolt
    • Ubuntu 18.04
      wget https://apt.puppet.com/puppet6-release-bionic.deb
      sudo dpkg -i puppet6-release-bionic.deb
      sudo apt-get update 
      sudo apt-get install puppet-bolt
  2. Run a Bolt command and get started.
    bolt --help

Install Bolt on RHEL, SLES, or Fedora

Packaged versions of Bolt are available for Red Hat Enterprise Linux 6 and 7, SUSE Linux Enterprise Server 12, and Fedora 28 and 29.

The Puppet repository for the YUM package management system is http://yum.puppet.com. Packages are named using the convention <PLATFORM_NAME>-release-<OS ABBREVIATION>-<OS VERSION>.noarch.rpm. For example, the release package for Puppet 6 Platform on Linux 7 is puppet6-release-el-7.noarch.rpm.

  1. Download and install the software and its dependencies. Use the commands appropriate to your system.
    • RHEL 6
      sudo rpm -Uvh https://yum.puppet.com/puppet6-release-el-6.noarch.rpm
      sudo yum install puppet-bolt			
    • RHEL 7
      sudo rpm -Uvh https://yum.puppet.com/puppet6-release-el-7.noarch.rpm
      sudo yum install puppet-bolt
    • RHEL 8
      sudo rpm -Uvh https://yum.puppet.com/puppet6-release-el-8.noarch.rpm
      sudo yum install puppet-bolt
    • SUSE Linux Enterprise Server 12
      sudo rpm -Uvh https://yum.puppet.com/puppet6-release-sles-12.noarch.rpm
      sudo zypper install puppet-bolt
    • Fedora 28
      sudo rpm -Uvh https://yum.puppet.com/puppet6-release-fedora-28.noarch.rpm
      sudo dnf install puppet-bolt
    • Fedora 29
      sudo rpm -Uvh https://yum.puppet.com/puppet6-release-fedora-29.noarch.rpm
      sudo dnf install puppet-bolt
  2. Run a Bolt command and get started.
    bolt --help

Install gems with Bolt packages

Bolt packages include their own copy of Ruby.

When you install gems for use with Bolt, use the --user-install flag to avoid requiring privileged access for installation. This option also enables sharing gem content with Puppet installations — such as when running apply on localhost — that use the same Ruby version.

To install a gem for use with Bolt, use the command appropriate to your operating system: 
  • On Windows with the default install location, "C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <gem>

  • On other platforms, /opt/puppetlabs/bolt/bin/gem install --user-install <gem>

Install Bolt as a gem

Starting with Bolt 0.20.0, gem installations no longer include core task modules.

To install Bolt reliably and with all dependencies, use one of the Bolt installation packages instead of a gem.

Analytics data collection

Bolt collects data about how you use it. You can opt out of providing this data.

What data does Bolt collect?

  • Version of Bolt
  • The Bolt command executed (for example, bolt task run or bolt plan show), excluding arguments
  • The functions called from a plan, excluding arguments

  • User locale
  • Operating system and version
  • Transports used (SSH, WinRM, PCP) and number of targets
  • The number of nodes and groups defined in the Bolt inventory file

  • The number of nodes targeted with a Bolt command

  • The output format selected (human-readable, JSON) 

  • The number of times Bolt tasks and plans are run (This does not include user-defined tasks or plans.)

  • The number of statements in an apply block, and how many resources that produces for each target

  • The number of steps in a YAML plan

  • The return type (expression vs. value) of a YAML plan

This data is associated with a random, non-identifiable user UUID.

To see the data Bolt collects, add --debug to a command.

Why does Bolt collect data?

Bolt collects data to help us understand how it's being used and make decisions about how to improve it.

How can I opt out of Bolt data collection?

To disable the collection of analytics data add the following line to ~/.puppetlabs/bolt/analytics.yaml:
disabled: true
Back to top
The page rank or the 1 our of 5 rating a user has given the page.
The email address of the user submitting feedback.
The URL of the page being ranked/rated.