mammoth external-key
Generated from mammoth-cli 2.4.2, released 2026-11-02:
mammoth schema list,mammoth capability listand the CLI's own--help. Do not edit by hand; runnpm run docs:capabilities.
Manage LLM provider keys (OpenAI, Anthropic, etc.) used by AI features. 4 commands.
Every command also takes the global flags (--output, --yes, --confirm, --dry-run, --input, --profile, ...), which are not repeated below. --input takes a JSON or YAML document of the input fields; mammoth schema get COMMAND_ID prints a command's full input schema.
Confirmation. Commands marked --yes --confirm TARGET or --yes always need those flags, even at a terminal: they never prompt. Commands marked "--yes or prompt" ask at an interactive terminal (table output, no --no-input) and otherwise need --yes. --dry-run skips confirmation and sends nothing.
Summary
| Command | What it does | Effect | Confirmation |
|---|---|---|---|
external-key create | Create an external (LLM provider) API key. | High impact | --yes --confirm TARGET |
external-key delete | Permanently delete one LLM provider key by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
external-key get | Get one LLM provider key by id. | Read | — |
external-key list | List the workspace's LLM provider keys (OpenAI, Anthropic, etc.). | Read | — |
external-key commands
mammoth external-key create
Create an external (LLM provider) API key.
mammoth external-key create --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
key_type | --input field | yes | — | ExternalKeyType | One of open_ai, anthropic, gemini, grok. |
key_name | --input field | yes | — | str | |
secure_key | --input field | yes | — | str | |
description | --input field | no | — | str | |
model_id | --input field | no | — | str | |
model_settings | --input field | no | — | ModelConfigSpec |
- Effect: High impact, scope
workspace· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: secure_key is a secret_fields entry: --input FILE, mode 0600 (shell) or the --input JSON's secure_key field (embedded), behind the confirmation card; never in a reply, note, checkpoint or run log. Response is recursively redacted.
- Id:
external-key.create· Result:ExternalKeyCreateResult· Backed by: SDKmammoth.api.external_keys.ExternalKeysAPI.create, APIPOST /workspaces/{workspace_id}/external_keys(AddExternalKey)
mammoth external-key delete
Permanently delete one LLM provider key by id. Prompt or '--yes' required.
mammoth external-key delete 123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
KEY_ID | positional | yes | — | int | ID of the key. |
- Effect: Destructive, scope
workspace· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Immutable ID confirmation.
- Id:
external-key.delete· Result:ExternalKeyDeleteResult· Backed by: SDKmammoth.api.external_keys.ExternalKeysAPI.delete, APIDELETE /workspaces/{workspace_id}/external_keys/{key_id}(DeleteExternalKey)
mammoth external-key get
Get one LLM provider key by id.
mammoth external-key get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
KEY_ID | positional | yes | — | int | ID of the key. |
- Effect: Read, scope
workspace· Confirmation: none - Preconditions: Required inputs: KEY_ID.
- Id:
external-key.get· Result:ExternalKeyGetResult· Backed by: SDKmammoth.api.external_keys.ExternalKeysAPI.get, APIGET /workspaces/{workspace_id}/external_keys/{key_id}(GetExternalKey)
mammoth external-key list
List the workspace's LLM provider keys (OpenAI, Anthropic, etc.).
mammoth external-key list
- Effect: Read, scope
workspace· Confirmation: none · Pages:single_page - Id:
external-key.list· Result:ExternalKeyListResult· Backed by: SDKmammoth.api.external_keys.ExternalKeysAPI.list, APIGET /workspaces/{workspace_id}/external_keys(GetKeysByWorkspaceId)