Skip to content
Build with Mammoth › CLI reference: open the docs menu

Other commands

Generated from mammoth-cli 2.4.2, released 2026-11-02: mammoth schema list, mammoth capability list and the CLI's own --help. Do not edit by hand; run npm run docs:capabilities.

10 commands that are a family of one. API operations with no CLI command are listed on the capability contract page.

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

CommandWhat it doesEffectConfirmation
calcEvaluate one arithmetic expression exactly.Read—
capabilitiesList what the CLI cannot do yet, and what to do instead.Read—
doctorRun environment and connectivity diagnostics.Read—
howTurn a plain-language goal into an ordered recipe of commands.Read—
linkRead the workspace, project, folder, dataset and view ids out of a pasted app URL.Read—
report listList reports in the active workspace, with optional 'limit'/'offset'.Read—
resolveSay what NAME refers to: a dataset, a view or a project, with ids and projects.Read—
runRun many commands in one process: JSON Lines of cmd, args, input and flags.Read—
upgradeUpgrade the mammoth CLI to the latest (or a specified) version from PyPI.External effect--yes or prompt
version—Read—

Commands

mammoth calc

Evaluate one arithmetic expression exactly.

mammoth calc '2063664 - 1917815'
NamePassed asRequiredDefaultTypeNotes
EXPRESSIONpositionalyes—strArithmetic expression: + - * / and parentheses, unary +/-, a trailing %% (divides by 100), and round(x[, ndigits]).
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Every number reported to the user comes from a tool result: use calc for a single expression, view data compare for a per-key comparison across two views. Never compute a difference or percentage mentally.
  • Id: calc · Result: CalcResult

mammoth capabilities

List what the CLI cannot do yet, and what to do instead.

mammoth capabilities
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Lists only the known gaps. A goal it does not name may simply be supported; run mammoth how GOAL or mammoth schema find WORDS.
  • Id: capabilities · Result: CapabilitiesResult

mammoth doctor

Run environment and connectivity diagnostics.

mammoth doctor
NamePassed asRequiredDefaultTypeNotes
wait--input fieldno0int
  • Effect: Read, scope local · Confirmation: none
  • Preconditions: Prints the report either way; exits 4 when the report's ok is false.
  • Id: doctor · Result: DoctorResult

mammoth how

Turn a plain-language goal into an ordered recipe of commands.

mammoth how 'refresh a dataset daily'
NamePassed asRequiredDefaultTypeNotes
GOALpositionalyes—strThe goal in plain words, for example "refresh a dataset daily" or "blend two files by day".
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Required inputs: GOAL.
  • Id: how · Result: HowResult

Read the workspace, project, folder, dataset and view ids out of a pasted app URL.

mammoth link https://app.mammoth.io/workspaces/1/projects/2/data/datasets
NamePassed asRequiredDefaultTypeNotes
URLpositionalyes—strA Mammoth web app address pasted by the user.
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Folder and selected ids in a link are web app resource ids, not dataset or view ids; only /datasets/ID and /views/ID links carry those directly.
  • Id: link · Result: LinkResult

mammoth report list

List reports in the active workspace, with optional 'limit'/'offset'.

mammoth report list
NamePassed asRequiredDefaultTypeNotes
limit--input fieldno50int
offset--input fieldno0int
  • Effect: Read, scope profile · Confirmation: none · Pages: offset
  • Id: report.list · Result: ReportListResult · Backed by: SDK mammoth.api.reports.ReportsAPI.list, API GET /reports (GetReports)

mammoth resolve

Say what NAME refers to: a dataset, a view or a project, with ids and projects.

mammoth resolve uqa-w29-ren
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalyes—strCase-insensitive name, or part of one, to look up as a dataset, view or project.
all_projects--input fieldnofalsebool
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Required inputs: NAME.
  • Id: resolve · Result: ResolveResult

mammoth run

Run many commands in one process: JSON Lines of cmd, args, input and flags.

One command per line: {"cmd": "view task list", "args": ["290"], "input": {}, "flags": {"project": 1}, "id": "a"}. cmd is the command path, args its positionals, input its --input document, flags the global flags by long name (yes, confirm, dry-run, project). Prints each line's envelope plus line, cmd and exit, then a summary; stops at the first failed line (exit = its status) unless --continue. No global --yes: a mutating line carries its own. --dry-run, --profile and --project apply to every line. FILE defaults to stdin; --continue may come before or after it. Steps: name a line ("name": "up") and a later line reads its result as "{{steps.up.data.dataset.id}}" in args, input or flags; "when": {"eq": [A, B]} skips a line; "for_each": "{{steps.ls.data}}" runs it once per item ("{{item}}", "{{index}}"). JSON expressions only, no code.

mammoth run commands.jsonl
NamePassed asRequiredDefaultTypeNotes
FILEpositionalno—strJSON Lines file with one command per line, or '-' (the default) for stdin.
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: run has no global --yes or --confirm; a mutating line carries its own in flags. Not available embedded.
  • Id: run · Result: RunResult

mammoth upgrade

Upgrade the mammoth CLI to the latest (or a specified) version from PyPI.

mammoth upgrade --yes
NamePassed asRequiredDefaultTypeNotes
--checkflagno—flagReport installed vs latest version; make no changes.
--versionflagno—strUpgrade to this exact version instead of the latest.
  • Effect: External effect, scope profile · Confirmation: --yes, or answer the prompt at an interactive terminal
  • Preconditions: Installs a different mammoth CLI version from PyPI over the current one. Run mammoth version first. Needs a prompt or --yes; the install is skipped when the version is already current.
  • Id: upgrade · Result: UpgradeResult

mammoth version

The CLI gives this command no description.

mammoth version
  • Effect: Read, scope local · Confirmation: none
  • Id: version · Result: VersionResult

Report an issue · support@mammoth.io