|
| 1 | + |
| 2 | +# 1password-cli (1password-cli) |
| 3 | + |
| 4 | +Installs the 1Password CLI inside of your devcontainer. You can also pass in a 1Password token to authenticate with 1Password. |
| 5 | + |
| 6 | +## Example Usage |
| 7 | + |
| 8 | +```json |
| 9 | +"features": { |
| 10 | + "ghcr.io/jmcombs/devcontainer-features/1password-cli:1": {} |
| 11 | +} |
| 12 | +``` |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +## OS & Architecture Support |
| 17 | + |
| 18 | +- Debian/Ubuntu Linux distributions with the `apt` package manager. |
| 19 | +- `amd64`, `arm64`, and `arm/v7` architectures are supported. |
| 20 | + |
| 21 | +## Configuration |
| 22 | + |
| 23 | +There are two options for using this implementation of the 1Password CLI: |
| 24 | + |
| 25 | +1. [Use service accounts with 1Password CLI](https://developer.1password.com/docs/service-accounts/use-with-1password-cli) |
| 26 | +2. [Use 1Password CLI with a Connect server](https://developer.1password.com/docs/connect/connect-cli) |
| 27 | + |
| 28 | +Both require using environment variables. The following are examples of how to set the environment variables for `devcontainer.json`based on which option (from above) is used: |
| 29 | + |
| 30 | +### Service Account |
| 31 | + |
| 32 | +```json |
| 33 | +"features": { |
| 34 | + "ghcr.io/jmcombs/devcontainer-features/google-cloud-sdk:latest": {}, |
| 35 | + "ghcr.io/jmcombs/devcontainer-features/ngrok:latest": {} |
| 36 | +}, |
| 37 | +... |
| 38 | +"containerEnv": { |
| 39 | + "OP_SERVICE_ACCOUNT_TOKEN": "thisismyserviceaccount", |
| 40 | + "OP_CONNECT_HOST": "thisismyconnecthost", |
| 41 | + "OP_CONNECT_TOKEN": "thisismyconnecttoken" |
| 42 | +} |
| 43 | +``` |
| 44 | + |
| 45 | +### Connect Server |
| 46 | + |
| 47 | +```json |
| 48 | +"features": { |
| 49 | + "ghcr.io/jmcombs/devcontainer-features/google-cloud-sdk:latest": {}, |
| 50 | + "ghcr.io/jmcombs/devcontainer-features/ngrok:latest": {} |
| 51 | +}, |
| 52 | +... |
| 53 | +"containerEnv": { |
| 54 | + "OP_CONNECT_HOST": "thisismyconnecthost", |
| 55 | + "OP_CONNECT_TOKEN": "thisismyconnecttoken" |
| 56 | +} |
| 57 | +``` |
| 58 | + |
| 59 | + |
| 60 | +--- |
| 61 | + |
| 62 | +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/jmcombs/devcontainer-features/blob/main/src/1password-cli/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
0 commit comments