mammoth-cli

Use Mammoth Analytics from a terminal. The mammoth command covers data import and export, transformations, project organization, automation, and administration. Its interface is designed to be readable at a shell and predictable in scripts and agent runs.

• Human-friendly by default. In a terminal, commands print a readable table.
• Agent-native. When output is piped, you get a stable JSON envelope with a documented schema, exit codes, and error codes — no flags required.
• Guarded mutations. Commands expose their confirmation policy; promptless destructive operations require an explicit --yes.
• Discoverable. mammoth capability list and mammoth schema get describe every command, so an agent can learn the surface at runtime.

The CLI is built on the public mammoth-io SDK. It adds no second HTTP client and calls no private SDK members.

See the capability matrix for current row-level coverage and evidence status.

Install

Install the 2.0.0 CLI without a preinstalled Python tool manager:

curl -fsSL https://raw.githubusercontent.com/EdgeMetric/mammothsdk/main/mammoth-cli/installers/mammoth-install.sh | bash -s -- --version 2.0.0 --noninteractive

Open a new shell if needed so the installer-added tool directory is on PATH, then confirm it works:

mammoth --version
mammoth doctor          # checks config, credentials, endpoint, connectivity

The installer bootstraps its pinned uv tool environment when needed. See docs/installation.md for the installer contract and the SDK-only pip installation path.

Quick start

mammoth auth login               # prompts for API key, API secret, workspace id
mammoth doctor                   # confirm credentials resolve and the API answers
mammoth project list             # a table in a terminal, JSON when piped
mammoth dataset list --project 180

Full walkthrough: docs/quickstart.md.

The login command has no workspace shortcut flag. For CI or an agent, use a protected request document instead:

chmod 600 creds.json
mammoth auth login --input creds.json --output json --no-input

Built for agents and CI

Piping or redirecting output yields the machine envelope, and --no-input turns on automatically off a terminal, so an agent needs no special flags:

mammoth project list | jq '.data'

To be explicit, pass --output json --no-input. Log in without a prompt with a permission-checked file:

mammoth auth login --input creds.json --output json --no-input

Feed multi-field requests as one document instead of many flags:

mammoth view transform math 1039 --project 180 \
  --input '{"expression": "Unit Price * Quantity", "new_column": "Revenue"}'

For pipeline transformations, prefer the typed commands and inspect their schemas before composing input. For example:

mammoth schema get view.transform.filter --output json --no-input
mammoth schema get view.transform.math --output json --no-input
mammoth schema get view.transform.substring --output json --no-input

The generic view task add, view task preview, and view task update commands are low-level expert routes. Their task_spec object is intentionally opaque in the installed schema; use a typed view transform command instead of inventing task fields. High-impact imports must also identify and confirm their target explicitly, for example:

mammoth dashboard import-workbook ./sample.twbx --project 456 \
  --yes --confirm 456 --output json --no-input

The sample path and project ID are placeholders for a local workbook and a project you have resolved and are authorized to modify.

The one-line installer already set up the bundled agent skill for Claude Code, Codex, and Cursor. If you installed with uv, pipx, or pip instead:

mammoth skill install

See docs/agents.md and the agent skill.

For a fresh external shell agent, start with the shipped portable task-start playbook.

For an unattended task, use the open-ended loop documented in Agent and CI usage: discover a capability and its schema, resolve every resource in its explicit scope, compose operations from the IDs returned by reads, verify the requested outcome, then recover or clean up from the observed state. Examples in this repository are nonexhaustive. The CLI never requires an agent to use backend column identifiers: inputs name columns by their display names. Do not infer a usable default view from a dataset; run view list DATASET_ID and choose a view explicitly.

If another agent must continue the work, write the nonsecret checkpoint format described in Portable agent handoff. It records scope, intent, verified evidence, jobs/unknown outcomes, and cleanup ownership without putting credentials into the handoff.

Give your coding agent the CLI playbook

The bundled skill describes authentication, discovery, structured input, job handling, and confirmations. Install it for the supported coding-agent tools:

mammoth skill install
mammoth skill list

The default target is user scope. To inspect destinations before writing, run mammoth skill path. To install only for one agent in the current project, use structured input:

mammoth skill install --input '{"agents": ["codex"], "scope": "project"}'

Use mammoth skill update after a CLI upgrade. It refreshes copies owned by the installer and reports modified copies instead of silently replacing them.

What you can do

The full generated list is in docs/reference/commands.md.

Documentation

Start with Quick start for a copy-paste workflow, Authentication for profiles and non-interactive login, or Agent and CI usage for schema-driven automation. The command reference is generated; use mammoth schema get COMMAND.ID to verify a request shape against the installed CLI.

Agent-readable indexes: docs/llms.txt and docs/llms-full.txt.

Capability-matrix status

The committed machine-readable release matrix is the canonical repository inventory; historical readiness records are kept separately from this summary. The repository-facing summary is docs/agent-capability-coverage.md. The current release snapshot contains 528 operations across 355 paths (the historical pinned M0 snapshot was 445 operations across 287 paths). The matrix separates Core ETL/workflow capabilities from Miscellaneous surfaces. Its live status counts are intentionally not duplicated here; read the linked row-level matrix for the current values. It does not declare Full readiness: matrix rows are planning/review status, not release qualification or live semantic proof. No status changes are inferred from an OpenAPI refresh: additions begin Unassessed and removals or operation-ID changes require review. Use scripts/report_release_capability_drift.py --help to produce a deterministic local review queue from a candidate OpenAPI JSON; it never implements routes or promotes support. See the capability drift workflow for the required row fields and review steps. No secrets or live evidence are copied into this README. The sanitized row-level release matrix and machine-readable matrix preserve all 528 method/path line items without pilot payloads or credentials.

Core top-15 snapshot

This compact table is a navigation summary, not a family-wide qualification claim. The linked matrix row is canonical; Unassessed means no support claim.

Use the canonical matrix for the full 528-row inventory and exact evidence links.

Compatibility

mammoth-cli follows Semantic Versioning for the 1.x series:

• The machine-output and error-envelope contract is stable. SCHEMA_VERSION (see mammoth_cli/__init__.py) identifies it and never changes incompatibly within a major version. New fields may be added; existing ones are preserved.
• The CLI surface is stable. Command names, flags, and exit codes are not removed or repurposed within a major version.
• Bug fixes ship in patch releases. Additive changes ship in minor releases.

Development

pytest tests/ -q                 # unit + contract tests (live tests deselected)
ruff check mammoth_cli scripts tests
mypy mammoth_cli
make cli-docs-check              # documentation gates

Build scripts under scripts/ regenerate the manifests and the documentation corpus offline. Release and packaging details live in ../RELEASING.md.

License

See LICENSE. Source: https://github.com/EdgeMetric/mammothsdk