Skip to content
terminal

GitHub Action

Setup Vault CLI

v1.0.3 Latest version

Setup Vault CLI

terminal

Setup Vault CLI

Setup HashiCorp Vault CLI on GitHub Actions runners

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Setup Vault CLI

uses: eLco/setup-vault@v1.0.3

Learn more about this action in eLco/setup-vault

Choose a version

setup-vault

setup-vault status

About

The eLco/setup-vault action is a JavaScript action that sets up Vault CLI in your GitHub Actions workflow by:

  • Downloading a specific version of Vault CLI and adding it to the PATH.

After you've used the action, subsequent steps in the same job can run arbitrary vault commands using the GitHub Actions run syntax. This allows most vault commands to work exactly like they do on your local command line.

Usage

This action can be run on ubuntu-latest, windows-latest, and macos-latest GitHub Actions runners, and will install and expose a specified version of the vault CLI on the runner environment.

The default configuration installs the latest version of vault CLI.

Setup the vault CLI:

steps:
  - uses: eLco/setup-vault@v1

A specific version of the vault CLI can be installed:

steps:
  - uses: eLco/setup-vault@v1
    with:
      vault_version: 1.8.7

A specific version of the vault CLI can be installed, using personal github token:

steps:
  - uses: eLco/setup-vault@v1
    with:
      vault_version: 1.8.7
      github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}

Inputs

The actions supports the following inputs:

  • vault_version: (optional) The version of vault to install, defaulting to latest
  • github_token: (optional) if set, github_token will be used for Octokit authentication. Defaulting to GitHub App installation access token.

License

MIT.