Caution

This provider is still in the experimental stage and may change in the future.

1Password CLI provider

Read values from 1Password using the op command.

Source type

1password:op

Important

To utilize this provider, verify that the op command is installed and properly configured.

Importantly, you need to enable the Integrate with 1Password CLI option in the 1Password Desktop app. For additional information, refer to the official installation guide.

Configuration layout

[[sources]]
type = "1password:op"
name = "op"

[[secrets]]
name = "WP_USER"
source = "op"
ref = "Wordpress"
field = "password"

sources:
  - type: 1password:op
    name: op

secrets:
  - name: WP_USER
    source: op
    ref: Wordpress
    field: password

{
  "sources": [
    {
      "type": "1password:op",
      "name": "op"
    }
  ],
  "secrets": [
    {
      "name": "WP_USER",
      "source": "op",
      "ref": "Wordpress",
      "field": "password"
    }
  ]
}

[[tool.secrets-env.sources]]
type = "1password:op"
name = "op"

[[tool.secrets-env.secrets]]
name = "WP_USER"
source = "op"
ref = "Wordpress"
field = "password"

Source section

Tip

All source configuration are optional.

bin

Defines the path to the op command. By default, the system path is used.

Secrets section

The configuration in the secrets section defines the item and field to retrieve from 1Password.

Note

A field name followed by a bookmark icon () indicates that it is a required parameter.

ref

The item ID or name in 1Password.

The value can be either the item’s UUID or its title, and it is case-insensitive.

field

Field to retrieve from the item.

Both field names and field UUIDs are supported, and they are case-insensitive.

Simplified layout

This provider accepts 1Password’s secret reference as the simplified representation.

[sources]
type = "1password:op"

[secrets]
WP_USER = "op://Private/2yysndf2j5bhracufqakofhb3e/email"

sources:
  - type: 1password:op

secrets:
  WP_USER: "op://Private/2yysndf2j5bhracufqakofhb3e/email"