diff --git a/README.md b/README.md index b4db5cc..1ba8417 100644 --- a/README.md +++ b/README.md @@ -796,35 +796,37 @@ nrq users get 12345 Configure nrq credentials. -#### config set-api-key +#### Setting the API key -Set the New Relic API key. +The API key is stored in the OS keyring and is **never** taken as a +flag/positional literal (§1.5). Use `nrq init` (the standard setup +path) or `nrq set-credential` for non-interactive ingress: ```bash -# Interactive (recommended) -nrq config set-api-key +# Interactive setup (no-echo prompt) +nrq init -# Inline (less secure - visible in shell history) -nrq config set-api-key NRAK-xxxxxxxxxxxxxxxxxxxx +# Scripted ingress (op → env → --from-env, or stdin) +op read "op://Vault/New Relic/api key" | nrq set-credential --key api_key --stdin +nrq set-credential --key api_key --from-env NEWRELIC_API_KEY ``` -#### config set-account-id +`nrq config set-api-key` was removed; a stub remains that prints the +migration message above. See also the §1.5 note further up. -Set the New Relic account ID. +#### config set -```bash -nrq config set-account-id 12345678 -``` - -#### config set-region - -Set the New Relic region. +Set non-secret fields (`account_id`, `region`) in `config.yml`: ```bash -nrq config set-region US # Default -nrq config set-region EU # European datacenter +nrq config set --account-id 12345678 +nrq config set --region US # or EU +nrq config set --account-id 12345678 --region EU # combined ``` +`nrq config set-account-id ` and `nrq config set-region ` remain +as thin deprecating aliases of `config set` (one cycle). + #### config show Show current configuration status.