The CircleCI shell plugin allows you to use 1Password to securely authenticate the CircleCI CLI with your fingerprint, Apple Watch, or system authentication, rather than storing your credentials in plaintext. Follow the instructions to configure your default credentials and source theDocumentation Index
Fetch the complete documentation index at: https://www.1password.dev/llms.txt
Use this file to discover all available pages before exploring further.
plugins.sh file, then you’ll be prompted to authenticate the CircleCI CLI with biometrics.
Requirements
- Sign up for 1Password.
- Install and sign in to 1Password for Mac or Linux.
- Install 1Password CLI 2.9.0 or later.
- Integrate 1Password CLI with the 1Password app.
- Install the CircleCI CLI.
- Bash
- Zsh
- fish
Before you begin: Create and save a CircleCI personal API token
If you’ve already created a CircleCI personal API token, skip to Step 1. If you haven’t created a personal API token yet, you can create one and use the 1Password browser extension to quickly save it in 1Password:- Open and unlock 1Password in your browser.
- Follow the steps to create a CircleCI personal API token.
- Select Save item when 1Password asks if you want to save an item for the CircleCI personal API token.
- Choose the vault where you want to save the item, edit the item’s name and details, then select Save item.
Step 1: Configure your default credentials
Step 2: Source the plugins.sh file
To make the plugin available, source your plugins.sh file. For example:
The file path for your op folder may vary depending on your configuration directory. op plugin init will output a source command with the correct file path.
If this is your first time installing a shell plugin, you’ll also need to add the source command to your RC file or shell profile to persist the plugin beyond the current terminal session. For example:
Step 3: Use the CLI
Step 4: Remove imported credentials from disk
After saving your credentials in 1Password, you can remove all local copies you previously had stored on disk.
Next steps
1Password Shell Plugins support more than 60 third-party CLIs. To see a list of supported CLIs:
To choose another plugin to get started with:
To use shell plugins for seamless context switching, learn how to configure a plugin in multiple environments or with multiple accounts.
Get help
Reference
1Password authenticates with by injecting environment variables with the credentials required by the plugin commands directly from your 1Password account.
If you saved your credentials in 1Password manually rather than using op plugin to import a new item, make sure that your field names match the table below.
If the item doesn’t contain a field with the required name, you’ll be prompted to rename one of the existing fields.
| 1Password field name | Environment variable |
|---|---|
| Token | CIRCLECI_CLI_TOKEN |