mammoth addon
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 workspace add-ons. 6 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 |
|---|---|---|---|
addon connector add | Add connector addon(s): pass 'connector_id' or 'connector_ids'. | High impact | --yes --confirm TARGET |
addon connector remove | Remove connector addon(s): pass 'connector_id' or 'connector_ids'. | High impact | --yes --confirm TARGET |
addon storage add | Add storage capacity. High-impact: '--yes --confirm WORKSPACE_ID'. | High impact | --yes --confirm TARGET |
addon storage remove | Remove storage capacity. High-impact: '--yes --confirm WORKSPACE_ID'. | High impact | --yes --confirm TARGET |
addon user add | Add user seats. High-impact: '--yes --confirm WORKSPACE_ID'. | High impact | --yes --confirm TARGET |
addon user remove | Remove user seats. High-impact: '--yes --confirm WORKSPACE_ID'. | High impact | --yes --confirm TARGET |
addon connector
mammoth addon connector add
Add connector addon(s): pass 'connector_id' or 'connector_ids'.
mammoth addon connector add --input '{"connector_id": 42}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
connector_id | --input field | no | — | int | |
connector_ids | --input field | no | — | list[int] |
- Effect: High impact, scope
profile· 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: Adds paid connector add-ons to the workspace and changes its bill. Pass connector_id or connector_ids. Needs --yes and --confirm TARGET (the refusal prints the exact target).
- Id:
addon.connector.add· Result:AddonConnectorAddResult· Backed by: SDKmammoth.api.addons.AddonsAPI.add_connector, APIPOST /workspaces/{workspace_id}/addons/connectors(AddConnectorAddon)
mammoth addon connector remove
Remove connector addon(s): pass 'connector_id' or 'connector_ids'.
mammoth addon connector remove --input '{"connector_id": 42}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
connector_id | --input field | no | — | int | |
connector_ids | --input field | no | — | list[int] |
- Effect: High impact, scope
profile· 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: Removes paid connector add-ons from the workspace; connections that use them stop working. Pass connector_id or connector_ids. Needs --yes and --confirm TARGET (the refusal prints the exact target).
- Id:
addon.connector.remove· Result:AddonConnectorRemoveResult· Backed by: SDKmammoth.api.addons.AddonsAPI.remove_connector, APIDELETE /workspaces/{workspace_id}/addons/connectors(RemoveConnectorAddon)
addon storage
mammoth addon storage add
Add storage capacity. High-impact: '--yes --confirm WORKSPACE_ID'.
mammoth addon storage add --input '{"additional_storage_gb": 1}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
additional_storage_gb | --input field | yes | — | int |
- Effect: High impact, scope
profile· 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: Adds paid storage to the workspace and changes its bill. Needs --yes and --confirm TARGET (the refusal prints the exact target).
- Id:
addon.storage.add· Result:AddonStorageAddResult· Backed by: SDKmammoth.api.addons.AddonsAPI.add_storage, APIPOST /workspaces/{workspace_id}/addons/storage(AddStorageAddon)
mammoth addon storage remove
Remove storage capacity. High-impact: '--yes --confirm WORKSPACE_ID'.
mammoth addon storage remove --input '{"removal_storage_gb": 1}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
removal_storage_gb | --input field | yes | — | int |
- Effect: High impact, scope
profile· 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: Removes paid storage from the workspace; it fails or data becomes read-only if usage exceeds what is left. Check
workspace storage-breakdownfirst. Needs --yes and --confirm TARGET (the refusal prints the exact target). - Id:
addon.storage.remove· Result:AddonStorageRemoveResult· Backed by: SDKmammoth.api.addons.AddonsAPI.remove_storage, APIDELETE /workspaces/{workspace_id}/addons/storage(RemoveStorageAddon)
addon user
mammoth addon user add
Add user seats. High-impact: '--yes --confirm WORKSPACE_ID'.
mammoth addon user add --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
user_count | --input field | no | 1 | int |
- Effect: High impact, scope
profile· 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: Adds paid user seats to the workspace and changes its bill. Needs --yes and --confirm TARGET (the refusal prints the exact target).
- Id:
addon.user.add· Result:AddonUserAddResult· Backed by: SDKmammoth.api.addons.AddonsAPI.add_users, APIPOST /workspaces/{workspace_id}/addons/users(AddUserSeatsAddon)
mammoth addon user remove
Remove user seats. High-impact: '--yes --confirm WORKSPACE_ID'.
mammoth addon user remove --input '{"user_count": 1}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
user_count | --input field | yes | — | int |
- Effect: High impact, scope
profile· 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: Removes paid user seats; fails if more users than seats would remain. Needs --yes and --confirm TARGET (the refusal prints the exact target).
- Id:
addon.user.remove· Result:AddonUserRemoveResult· Backed by: SDKmammoth.api.addons.AddonsAPI.remove_users, APIDELETE /workspaces/{workspace_id}/addons/users(RemoveUserSeatsAddon)