mammoth client-app
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 the workspace's API keys (client apps): key + secret credentials for scripts and integrations. 5 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 |
|---|---|---|---|
client-app create | Create a client app. Name comes from a positional or the 'app_name' field. | High impact | --yes --confirm TARGET |
client-app delete | Permanently delete one client app by its client key. Prompt or '--yes' required. | Destructive | --yes or prompt |
client-app get | Get one API key (client app) by its client key. | Read | — |
client-app list | List the workspace's API keys (client apps). Requires an admin role. | Read | — |
client-app update | Apply a patch request to one client app. Client key is positional. | High impact | --yes --confirm TARGET |
client-app commands
mammoth client-app create
Create a client app. Name comes from a positional or the 'app_name' field.
mammoth client-app create 'Revenue report' --yes --confirm 'Revenue report'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
APP_NAME | positional | no | — | str | Name of the new client app; or pass it via the 'app_name' input field. Or the app_name input field. |
app_name | --input field | no | — | str | |
description | --input field | no | — | str |
- 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: The app key and token are shown once, in this response only; store them at once. They are redacted from logs and diagnostics. Needs --yes.
- Id:
client-app.create· Result:ClientAppCreateResult· Backed by: SDKmammoth.api.clientapps.ClientAppsAPI.create, APIPOST /workspaces/{workspace_id}/clientapps(CreateApp)
mammoth client-app delete
Permanently delete one client app by its client key. Prompt or '--yes' required.
mammoth client-app delete web-client --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
CLIENT_KEY | positional | yes | — | str | Key identifying the client. |
- Effect: Destructive, scope
workspace· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Deletes the client app and invalidates its key for good. Needs --yes and --confirm CLIENT_KEY (the exact key).
- Id:
client-app.delete· Result:ClientAppDeleteResult· Backed by: SDKmammoth.api.clientapps.ClientAppsAPI.delete, APIDELETE /workspaces/{workspace_id}/clientapps/{client_key}(DeleteApp)
mammoth client-app get
Get one API key (client app) by its client key.
mammoth client-app get web-client
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
CLIENT_KEY | positional | yes | — | str | Key identifying the client. |
fields | --input field | no | — | str |
- Effect: Read, scope
workspace· Confirmation: none - Preconditions: client_key is a secret-bearing identifier and is redacted in diagnostics.
- Id:
client-app.get· Result:ClientAppGetResult· Backed by: SDKmammoth.api.clientapps.ClientAppsAPI.get, APIGET /workspaces/{workspace_id}/clientapps/{client_key}(AppDetails)
mammoth client-app list
List the workspace's API keys (client apps). Requires an admin role.
mammoth client-app list
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
limit | --input field | no | 10 | int | |
offset | --input field | no | 0 | int | |
fields | --input field | no | — | str | |
sort | --input field | no | — | str |
- Effect: Read, scope
workspace· Confirmation: none · Pages:offset - Preconditions: Lists the workspace's client apps.
- Id:
client-app.list· Result:ClientAppListResult· Backed by: SDKmammoth.api.clientapps.ClientAppsAPI.list, APIGET /workspaces/{workspace_id}/clientapps(ListApps)
mammoth client-app update
Apply a patch request to one client app. Client key is positional.
mammoth client-app update web-client --input '{"patch_request": {"patch": [{"op": "replace", "path": "role"}]}}' --yes --confirm web-client
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
CLIENT_KEY | positional | yes | — | str | Key identifying the client. |
patch_request | --input field | yes | — | PatchRequest |
- 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) - Id:
client-app.update· Result:ClientAppUpdateResult· Backed by: SDKmammoth.api.clientapps.ClientAppsAPI.update, APIPATCH /workspaces/{workspace_id}/clientapps/{client_key}(UpdateApp)