Skip to main content

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.

The Scaleway shell plugin lets you use 1Password to authenticate the Scaleway CLI (scw) with your fingerprint, Apple Watch, or system authentication, instead of storing API keys in plaintext. Follow the instructions to configure your default credentials and source the plugins.sh file, then you’ll be prompted to authenticate the Scaleway CLI with biometrics.
The plugin applies to the Scaleway CLI’s default configuration. It does not support separate CLI profiles.

Requirements

  1. Sign up for 1Password.
  2. Install and sign in to 1Password for Mac or Linux.
  3. Install 1Password CLI 2.34.0 or later.
  4. Integrate 1Password CLI with the 1Password app.
  5. Install and configure the Scaleway CLI .
The following shells are supported:
  • Bash
  • Zsh
  • fish

Before you begin: Create a Scaleway API key

If you already have a Scaleway API key, skip to step 1. Otherwise, create an API key in the Scaleway console and save the access key and secret key in 1Password. See Scaleway’s guide to creating API keys .

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

For example, after configuring the plugin, try:
scw account project list

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.

1Password field namesEnvironment variable
Access keySCW_ACCESS_KEY
Secret keySCW_SECRET_KEY
Default region (optional)SCW_DEFAULT_REGION
Default zone (optional)SCW_DEFAULT_ZONE
Project ID (optional)SCW_DEFAULT_PROJECT_ID
Organization ID (optional)SCW_DEFAULT_ORGANIZATION_ID
Thanks to @jksolbakken for contributing this plugin! Learn how to build your own shell plugins.

Learn more