diff options
Diffstat (limited to 'src/tools/cargo/credential/cargo-credential-1password/README.md')
| -rw-r--r-- | src/tools/cargo/credential/cargo-credential-1password/README.md | 38 |
1 files changed, 26 insertions, 12 deletions
diff --git a/src/tools/cargo/credential/cargo-credential-1password/README.md b/src/tools/cargo/credential/cargo-credential-1password/README.md index 3648efe4b..fc3c9460a 100644 --- a/src/tools/cargo/credential/cargo-credential-1password/README.md +++ b/src/tools/cargo/credential/cargo-credential-1password/README.md @@ -2,17 +2,31 @@ A Cargo [credential provider] for [1password]. -`cargo-credential-1password` uses the 1password `op` CLI to store the token. You must -install the `op` CLI from the [1password -website](https://1password.com/downloads/command-line/). You must run `op signin` -at least once with the appropriate arguments (such as `op signin my.1password.com user@example.com`), -unless you provide the sign-in-address and email arguments. The master password will be required on each request -unless the appropriate `OP_SESSION` environment variable is set. It supports -the following command-line arguments: -* `--account`: The account shorthand name to use. -* `--vault`: The vault name to use. -* `--sign-in-address`: The sign-in-address, which is a web address such as `my.1password.com`. -* `--email`: The email address to sign in with. +## Usage + +`cargo-credential-1password` uses the 1password `op` CLI to store the token. You +must install the `op` CLI from the [1password +website](https://1password.com/downloads/command-line/). + +Afterward you need to configure `cargo` to use `cargo-credential-1password` as +the credential provider. You can do this by adding something like the following +to your [cargo config file][credential provider]: + +```toml +[registry] +global-credential-providers = ["cargo-credential-1password --account my.1password.com"] +``` + +Finally, run `cargo login` to save your registry token in 1password. + +## CLI Arguments + +`cargo-credential-1password` supports the following command-line arguments: + +* `--account`: The account name to use. For a list of available accounts, + run `op account list`. +* `--vault`: The vault name to use. For a list of available vaults, + run `op vault list`. [1password]: https://1password.com/ -[credential provider]: https://doc.rust-lang.org/nightly/cargo/reference/registry-authentication.html +[credential provider]: https://doc.rust-lang.org/stable/cargo/reference/registry-authentication.html |