Use 1Password CLI with a Connect server

After you set up your Secrets Automation workflow and deploy 1Password Connect Server, you can use 1Password CLI with your Connect server to provision secrets and retrieve items on the command line.

Requirements

Before you can use 1Password CLI with your Connect server, you'll need to:

• Sign up for 1Password.
• Set up a Secrets Automation workflow.
• Deploy 1Password Connect in your infrastructure.
• Make your Connect server accessible to your production environment.
• Install 1Password CLI in your production environment.
• Set the OP_CONNECT_HOST and OP_CONNECT_TOKEN environment variables to your Connect instance's credentials in your production environment.

You can use the following commands with a Connect server:

• op run
• op inject
• op read
• op item get --format json

Optional: Set up the CI environment

You can also use 1Password CLI with your Connect server in CI. 1Password CLI allows you to use secret references in place of plaintext secrets in code, which can be set up to pass different sets of secrets for different environments.

Secret references work well within infrastructure as code tools and CI configurations, because they can be defined alongside other configurations. For example:

.gitlab-ci.yml

To authenticate 1Password CLI in the pipeline, add the following environment variables to your CI configuration file:

.gitlab-ci.yml

Learn more

Replace plaintext secrets with secret references

Learn how to create and use secret references to avoid putting plaintext secrets in code.

Load secrets into the environment

Learn how to source secrets from the environment into your applications.

Load secrets into config files

Learn how to load secrets automatically into config files without putting any plaintext secrets in code.