forge api-key
Manage project API keys.
Command
forge api-key <subcommand> [args]
Arguments
None. Use a
<subcommand> — run forge --help for per-subcommand arguments.
Subcommands
| Subcommand | Usage |
|---|---|
| |
| |
| |
Flags per subcommand
create:
| Flag | Type | Required | Notes |
|---|---|---|---|
| string | yes | Project slug |
| string | yes | Key display name |
list:
| Flag | Type | Required | Notes |
|---|---|---|---|
| string | yes | Project slug |
Examples
Create a key:
forge api-key create --project my-app --name ci-key
# → Key: bf_key_xxxxx (shown once only)
List keys:
forge api-key list --project my-app
# → bf_key_xxx ci-key active 2026-07-01
# → bf_key_yyy dev-key active 2026-06-15
Delete a key:
forge api-key delete bf_key_xxxxx --yes
Errors
| Exit code | Meaning |
|---|---|
| 0 | Success |
| 1 | Missing required arguments |
| 2 | Auth failure |
Pitfalls
- Plaintext shown once —
prints the plaintext API key exactly once. Save it immediately.create - List hides secrets —
never returns plaintext key values, only metadata.list
See also
{auto-injected}
Tested against
{auto-injected}