mammoth user
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 users and account settings. 7 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 |
|---|---|---|---|
user delete-account | Delete the current user's account. High-impact: '--yes --confirm WORKSPACE_ID'. | High impact | --yes --confirm TARGET |
user get | Get the current user's profile. | Read | — |
user update | Change the current user's own display name (first and/or last name). | Benign mutation | — |
user avatar delete | Delete the current user's avatar. Prompt or '--yes' required. | Destructive | --yes or prompt |
user avatar upload | Upload the current user's avatar. File comes from a positional or 'file'. | Benign mutation | — |
user preference get | Get the current user's preferences. | Read | — |
user preference update | Update the current user's preferences from the '--input' document. | Benign mutation | — |
user commands
mammoth user delete-account
Delete the current user's account. High-impact: '--yes --confirm WORKSPACE_ID'.
mammoth user delete-account --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
validate_only | --input field | no | — | bool |
- 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: Deletes the signed-in user's account for good. Pass validate_only to check what would be removed first. Needs --yes and --confirm WORKSPACE_ID (the refusal prints it).
- Id:
user.delete-account· Result:UserDeleteAccountResult· Backed by: SDKmammoth.api.users.UsersAPI.delete_account, APIDELETE /self(DeleteSelf)
mammoth user get
Get the current user's profile.
mammoth user get
- Effect: Read, scope
workspace· Confirmation: none - Id:
user.get· Result:UserGetResult· Backed by: SDKmammoth.api.user_profile.UserProfileAPI.get, APIGET /self(GetUserDetails)
mammoth user update
Change the current user's own display name (first and/or last name).
mammoth user update --input '{"first_name": "Jane"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
first_name | --input field | no | — | str | |
last_name | --input field | no | — | str |
- Effect: Benign mutation, scope
workspace· Confirmation: none - Id:
user.update· Result:UserUpdateResult· Backed by: SDKmammoth.api.user_profile.UserProfileAPI.update, APIPATCH /self(UpdateUser)
user avatar
mammoth user avatar delete
Delete the current user's avatar. Prompt or '--yes' required.
mammoth user avatar delete --yes
- Effect: Destructive, scope
workspace· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Removes the signed-in user's profile picture; upload it again to restore it. Needs a prompt or --yes.
- Id:
user.avatar.delete· Result:UserAvatarDeleteResult· Backed by: SDKmammoth.api.users.UsersAPI.avatar_delete, APIDELETE /self/avatar(DeleteAvatar)
mammoth user avatar upload
Upload the current user's avatar. File comes from a positional or 'file'.
mammoth user avatar upload ./sales.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
FILE | positional | no | — | str | Path to a local image to upload; or pass it via the 'file' input field. Or the file input field. |
file | --input field | no | — | str | Path | BinaryIO |
- Effect: Benign mutation, scope
workspace· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Id:
user.avatar.upload· Result:UserAvatarUploadResult· Backed by: SDKmammoth.api.users.UsersAPI.avatar_upload, APIPOST /self/avatar(UploadProfilePic)
user preference
mammoth user preference get
Get the current user's preferences.
mammoth user preference get
- Effect: Read, scope
workspace· Confirmation: none - Id:
user.preference.get· Result:UserPreferenceGetResult· Backed by: SDKmammoth.api.user_profile.UserProfileAPI.get_preferences, APIGET /preferences(GetUserPreferences)
mammoth user preference update
Update the current user's preferences from the '--input' document.
mammoth user preference update --input '{"patch": [{"op": "replace", "path": "GLOBAL.PREFERENCES.TOP_TABS", "value": []}]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
patch | --input field | no | — | list[dict[str, any]] |
- Effect: Benign mutation, scope
workspace· Confirmation: none - Preconditions: Body is the release {"patch": [{"op", "path", "value"}]} list; the CLI does not validate preference paths (observed key GLOBAL.PREFERENCES.TOP_TABS). Not verified live.
- Id:
user.preference.update· Result:UserPreferenceUpdateResult· Backed by: SDKmammoth.api.user_profile.UserProfileAPI.update_preferences, APIPATCH /preferences(UpdateUserPreferences)