Use 1Password to securely authenticate the AWS CDK Toolkit

Documentation Index

Fetch the complete documentation index at: https://www.1password.dev/llms.txt

Use this file to discover all available pages before exploring further.

​

Requirements

1. Sign up for 1Password.
2. Install and sign in to 1Password for Mac or Linux.
3. Install 1Password CLI 2.17.0 or later.
   
4. Integrate 1Password CLI with the 1Password app.
5. Install the AWS CDK Toolkit .
6. Make sure you have an AWS config file at ~/.aws/config on Mac or Linux, or C:\Users\USERNAME\.aws\config on Windows. If you don’t have a config file, use aws configure to create one. When prompted, skip entering your AWS access key pair to avoid writing your credentials on disk in the .aws/credetials file.

• Bash
• Zsh
• fish

​

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:

source ~/.config/op/plugins.sh

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:

op plugin list

To choose another plugin to get started with:

op plugin init

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.

​

Learn more

• Use shell plugins to switch between multiple environments
• Use shell plugins with multiple accounts
• Build your own shell plugins