Install and upgrade Bolt

Packaged versions of Bolt are available for several Linux distributions, macOS, and Microsoft Windows.

Get credentials to download and install Bolt

To download and install Bolt 5.0.0, which is stored in a protected repository, you must download authenticated packages using either Puppet Core or Puppet Enterprise (PE) credentials.

• Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

• PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

Install Bolt on Debian

Add credentials to your repository configuration

To download, install, or upgrade to Bolt 5.0.0 and later, you must authenticate using Puppet Core or PE credentials. Use the following steps to add credentials to your repository configuration.

1. In your /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf file, uncomment the login and password lines.

2. Edit the login and password to add credentials. Use either Puppet Core or PE credentials.

   • Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

   • PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

Install Bolt

To install Bolt, run the appropriate command for the version of Debian you have installed:

• Debian 11

  Copy

  wget https://apt-puppetcore.puppet.com/public/puppet8-release-bullseye.deb
  sudo dpkg -i puppet8-release-bullseye.deb
  # Before you update, edit /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf
  sudo apt-get update
  sudo apt-get install puppet-bolt
  

• Debian 12

  Copy

  wget https://apt-puppetcore.puppet.com/public/puppet8-release-bookworm.deb
  sudo dpkg -i puppet8-release-bookworm.deb
  # Before you update, edit /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf
  sudo apt-get update
  sudo apt-get install puppet-bolt
                      

Upgrade Bolt

1. Ensure that you Add credentials to your repository configuration.

2. To upgrade Bolt to the latest version, run the following command.

   Copy

   sudo apt-get update
   sudo apt install puppet-bolt
   

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo apt remove puppet-bolt

Install Bolt on Fedora

Add credentials to your repository configuration

To download, install, or upgrade to Bolt 5.0.0 and later, you must authenticate using Puppet Core or PE credentials. Use the following steps to add credentials to your repository configuration.

1. In your /etc/yum.repos.d/puppet8-release/repos file, uncomment the username and password lines.

2. Edit the username and password to add credentials. Use either Puppet Core or PE credentials.

   • Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

   • PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

Install Bolt

To install Bolt, run the appropriate command for the version of Fedora you have installed:

• Fedora 40

  Copy

  sudo rpm -Uvh https://yum-puppetcore.puppet.com/public/puppet8-release-fedora-40.noarch.rpm
  # Before you install, edit /etc/yum.repos.d/puppet8-release/repos
  sudo dnf install puppet-bolt
                      

• Fedora 41

  Copy

  sudo rpm -Uvh https://yum-puppetcore.puppet.com/public/puppet8-release-fedora-41.noarch.rpm
  # Before you install, edit /etc/yum.repos.d/puppet8-release/repos
  sudo dnf install puppet-bolt
                      

Upgrade Bolt

1. Ensure that you Add credentials to your repository configuration.

2. To upgrade Bolt to the latest version, run the following command:

Copy

sudo dnf upgrade puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo dnf remove puppet-bolt

Install Bolt on macOS

You can install Bolt packages for macOS using the macOS installer.

macOS installer (DMG)

To download, install, or upgrade to Bolt 5.0.0 and later, you must authenticate using Puppet Core or PE credentials.

Based on your preference, you can either download Bolt for macOS directly or you can use curl.

Download directly

You can download the Bolt macOS installer (DMG) directly using the following links:

• 13 (Ventura): https://artifacts-puppetcore.puppet.com/v1/download?type=bolt&os_name=osx&os_version=13&os_arch=x86_64&version=5.0.0

• 14 (Sonoma): https://artifacts-puppetcore.puppet.com/v1/download?type=bolt&os_name=osx&os_version=14&os_arch=x86_64&version=5.0.0

• 15 (Sequoia): https://artifacts-puppetcore.puppet.com/v1/download?type=bolt&os_name=osx&os_version=15&os_arch=x86_64&version=5.0.0

In the Sign In window, enter your Puppet Core or PE credentials to authenticate and download Bolt.

Download via curl

Directly curl the endpoints with credentials to download Bolt using the following steps.

1. Make sure to copy the download link for the macOS package you'd like to download from the previous section.

2. Export either of the following sets of credentials, ensuring that you use either a Forge username and password or a PE username and password.

   • Puppet Core: The string literal forge-key as the username and the Puppet Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

   • PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

     For example:

   • export USERNAME=forge-key

   • export PASSWORD=<API_KEY>

3. Call the credentials for the URL , for example:

   Copy

   curl -J -O -u forge-key:$PASSWORD "https://artifacts-puppetcore.puppet.com/v1/download?type=bolt&os_name=osx&os_version=14&os_arch=x86_64&version=5.0.0"

Install Bolt

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

1. Download the Bolt installer package for your macOS version.

   • 11 (Big Sur)
   • 12 (Monterey)
   • 13 (Ventura)
   • 14 (Sonoma)

2. Double-click the puppet-bolt-latest.dmg file to mount the installer and then double-click puppet-bolt-[version]-installer.pkg to run the installer.

If you get a message that the installer "can't be opened because Apple cannot check it for malicious software:"

1. Click > System Preferences > Security & Privacy.
2. From the General tab, click the lock icon to allow changes to your security settings and enter your macOS password.
3. Look for a message that says the Bolt installer "was blocked from use because it is not from an identified developer" and click "Open Anyway".
4. Click the lock icon again to lock your security settings.

Upgrade Bolt

To upgrade Bolt to the latest version, download the DMG again and repeat the installation steps.

Uninstall Bolt

To uninstall Bolt, remove Bolt's files and executable:

sudo rm -rf /opt/puppetlabs/bolt /opt/puppetlabs/bin/bolt

Install Bolt on Microsoft Windows

You can installBolt packages for Windows using Windows installer (MSI).

To download, install, or upgrade to Bolt 5.0.0 and later, you must authenticate using Puppet Core or PE credentials.

Download Bolt

Based on your preference, you can either download Bolt for Windows directly or you can use curl.

Download directly

You can download the Bolt Windows installer (MSI) directly from https://artifacts-puppetcore.puppet.com/v1/download?type=bolt&os_name=windows&os_version=latest&os_arch=x64&version=5.0.0

In the Sign In window, enter your Puppet Core or PE credentials to authenticate and download Bolt.

• Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

• PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

Download via curl

Directly curl the endpoints with credentials to download Bolt using the following steps.

1. Use either of the following sets of credentials, ensuring that you use either a Forge username and password or a PE username and password.

   • Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

   • PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

2. Call the credentials from the URL, for example:

   Copy

   curl -J -O -u "forge-key:<FORGE_API_KEY> "https://artifacts-puppetcore.puppet.com/v1/download?type=bolt&os_name=windows&os_arch=x64&version=5.0.0"

Install Bolt

Use the Windows installer (MSI) package to install Bolt on Windows:

1. Double-click the MSI file and run the installer.

2. Open a new terminal window and run: bolt --version

Upgrade Bolt

To upgrade Bolt to the latest version, download the MSI again and repeat the installation steps.

Uninstall Bolt

You can uninstall Bolt from Windows Apps & Features:

1. Press Windows + X + F to open Apps & Features.

2. Search for Puppet Bolt, select it, and click Uninstall.

Install Bolt on RHEL

Add credentials to your repository configuration

To download, install, or upgrade to Bolt 5.0.0 and later, you must authenticate using Puppet Core or PE credentials. Use the following steps to add credentials to your repository configuration.

1. In your /etc/yum.repos.d/puppet8-release/repos file, uncomment the username and password lines.

2. Edit the username and password to add credentials. Use either Puppet Core or PE credentials.

   • Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

   • PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

Install Bolt

To install Bolt, run the appropriate command for the version of RHEL you have installed:

• RHEL 7

  Copy

  sudo rpm -Uvh https://yum-puppetcore.puppet.com/public/puppet8-release-el-7.noarch.rpm
  # Before you install, edit /etc/yum.repos.d/puppet8-release/repos                        
  sudo yum install puppet-bolt
  

• RHEL 8

  Copy

  sudo rpm -Uvh https://yum-puppetcore.puppet.com/public/puppet8-release-el-8.noarch.rpm
  # Before you install, edit /etc/yum.repos.d/puppet8-release/repos
  sudo yum install puppet-bolt
  

• RHEL 9

  Copy

  sudo rpm -Uvh https://yum-puppetcore.puppet.com/public/puppet8-release-el-9.noarch.rpm
  # Before you install, edit /etc/yum.repos.d/puppet8-release/repos
  sudo yum install puppet-bolt
  

Upgrade Bolt

1. Ensure that you Add credentials to your repository configuration.

2. To upgrade Bolt to the latest version, run the following command:

   Copy

   sudo yum update puppet-bolt
   

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo yum remove puppet-bolt

Install Bolt on SLES

Add credentials to your repository configuration

To download, install, or upgrade to Bolt 5.0.0 and later, you must authenticate using Puppet Core or PE credentials. Use the following steps to add credentials to your repository configuration.

1. In your /etc/yum.repos.d/puppet8-release/repos file, uncomment the username and password lines.

2. Edit the username and password to add credentials. Use either Puppet Core or PE credentials.

   • Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

   • PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

Install Bolt

To install Bolt, run the appropriate command for the version of SLES you have installed:

• SLES 12

  Copy

  sudo rpm -Uvh https://yum-puppetcore.puppet.com/public/puppet8-release-sles-12.noarch.rpm
  # Before you install, edit /etc/yum.repos.d/puppet8-release/repos                        
  sudo zypper install puppet-bolt
  

• SLES 15

  Copy

  sudo rpm -Uvh https://yum-puppetcore.puppet.com/public/puppet8-
  release-sles-15.noarch.rpm 
  # Before you install, edit /etc/yum.repos.d/puppet8-release/repos
  sudo zypper install puppet-bolt
  

Upgrade Bolt

1. Ensure that you Add credentials to your repository configuration.

2. To upgrade Bolt to the latest version, run the following command:

   Copy

   sudo zypper update puppet-bolt
   

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo zypper remove puppet-bolt

Install Bolt on Ubuntu

Add credentials to your repository configuration

To download and install Bolt 5.0.0 and later, you must authenticate Puppet Core or PE credentials. Use the following steps to add credentials to your repository configuration.

1. In your /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf file, uncomment the login and password lines.

2. Edit the login and password to add credentials. Use either Puppet Core or PE credentials.

   • Puppet Core: The string literal forge-key as the username and the Puppet Core Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

   • PE: The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

Install Bolt

To install Bolt, run the appropriate command for the version of Ubuntu you have installed:

• Ubuntu 18.04

  Copy

  wget https://apt-puppetcore.puppet.com/public/puppet8-release-bionic.deb
  sudo dpkg -i puppet8-release-bionic.deb
  # Before you update, edit /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf
  sudo apt-get update 
  sudo apt-get install puppet-bolt
  

• Ubuntu 20.04

  Copy

  wget https://apt-puppetcore.puppet.com/public/puppet8-release-focal.deb
  sudo dpkg -i puppet8-release-focal.deb
  # Before you update, edit /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf
  sudo apt-get update 
  sudo apt-get install puppet-bolt
  

• Ubuntu 22.04

  Copy

  wget https://apt-puppetcore.puppet.com/public/puppet8-release-jammy.deb
  sudo dpkg -i puppet8-release-jammy.deb
  # Before you update, edit /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf
  sudo apt-get update 
  sudo apt-get install puppet-bolt
  

• Ubuntu 24.04

  Copy

  wget https://apt-puppetcore.puppet.com/public/puppet8-release-noble.deb
  sudo dpkg -i puppet8-release-noble.deb
  # Before you update, edit /etc/apt/auth.conf.d/apt-puppetcore-puppet.conf
  sudo apt-get update 
  sudo apt-get install puppet-bolt
  

Upgrade Bolt

1. Ensure that you Add credentials to your repository configuration.

2. To upgrade Bolt to the latest version, run the following command:

   Copy

   sudo apt-get update
   sudo apt install puppet-bolt
   

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo apt remove puppet-bolt

Install Bolt as a gem

To install Bolt reliably and with all dependencies, use one of the Bolt installation packages instead of a gem. Gem installations do not include core modules which are required for common Bolt actions.

It's best practice to make sure that you install up to date Puppet and Facter gems with the Bolt gem to ensure Bolt works as intended.

For example, to install Bolt as a gem:

# export a valid forge-key
export PUPPET_FORGE_TOKEN="<API_KEY>"

# create a test directory
mkdir test
cd test
            
# set the local configuration
bundle config --local bin vendor/bin
bundle config --local gemfile Gemfile
bundle config --local path vendor/bundle
bundle config set --global https://rubygems-puppetcore.puppet.com "forge-key:${PUPPET_FORGE_TOKEN}"
            
# create the Gemfile
cat << 'EOF' > Gemfile
source 'https://rubygems.org'
source 'https://rubygems-puppetcore.puppet.com' do
gem 'puppet', '~> 8.15'
gem 'facter', '~> 4.15'
gem 'bolt', '~> 5.0'
end
EOF
            
# install!
bundle install
            
# verify
bundle info bolt
bundle exec bolt --version

Install gems in Bolt's Ruby environment

Bolt packages include their own copy of Ruby.

When you install gems for use with Bolt, use the --user-install command-line option 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:
  Copy

  "C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <GEM>
  

• On other platforms:
  Copy

  /opt/puppetlabs/bolt/bin/gem install --user-install <GEM>