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 listandmammoth schema getdescribe 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.
Install
One step, no prerequisites. This installs uv if you do not already have it,
the mammoth CLI, and the agent skill for Claude Code, Codex, and Cursor:
curl -fsSL https://github.com/EdgeMetric/mammothsdk/releases/latest/download/mammoth-install.sh | sh
Windows PowerShell:
irm https://github.com/EdgeMetric/mammothsdk/releases/latest/download/mammoth-install.ps1 | iex
Then confirm it works:
mammoth --version
mammoth doctor # checks config, credentials, endpoint, connectivity
Already have a Python tool manager?
uv tool install mammoth-cli # isolated, on your PATH
pipx install mammoth-cli
python -m pip install mammoth-cli
The CLI supports Python 3.12, 3.13, and 3.14. These one-line commands execute downloaded code; for the verified (checksummed and signed) flow, see docs/installation.md.
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": "price * qty", "new_column": "total"}'
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.
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
| Area | Command families |
|---|---|
| Data in and out | file, dataset, connector, addon |
| Shape and analyze | view, dataset, ai |
| Organize | project, folder, dashboard, report, template |
| Automate | automation, workflow, schedule, batch, webhook |
| Administer | workspace, user, billing, client-app, external-key |
| Operate the CLI | auth, context, config, doctor, capability, schema, skill, upgrade |
The full generated list is in docs/reference/commands.md.
Documentation
| Guide | What it covers |
|---|---|
| Installation | Install the CLI and the agent skill. |
| Quick start | Log in and run your first commands. |
| Authentication | Getting an API key, login, profiles, projects. |
| Agent and CI usage | Machine output, structured input, patterns. |
| Safe mutation | Mutation classes and confirmation policies. |
| Output and errors | Envelopes, exit codes, error codes. |
| Global flags | The flags every command shares. |
| Troubleshooting | Exit codes, error envelopes, recovery. |
| Upgrade / Uninstall | Keep the CLI current, or remove it. |
| Command reference | Every command, grouped by family. |
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.
Compatibility
mammoth-cli follows Semantic Versioning for the 1.x
series:
- The machine-output and error-envelope contract is stable.
SCHEMA_VERSION(seemammoth_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
1 maintainer
Release files for mammoth-cli 1.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mammoth_cli-1.0.8.tar.gz | 424.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mammoth_cli-1.0.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 952.5 kB
Release files / mammoth_cli-1.0.8.tar.gz
| Download URL | mammoth_cli-1.0.8.tar.gz |
|---|---|
| Size | 424.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3cb4addce6c76ca27ab4021193d8f05937a8ec52125d8f38d3852e661bf26447
|
|
BLAKE2b-256 checksum How to use checksums |
7391a7a8c8d2c367462da4e7a2dd764af1e1db77fb92122045b47db4293448d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / mammoth_cli-1.0.8-py3-none-any.whl
| Download URL | mammoth_cli-1.0.8-py3-none-any.whl |
|---|---|
| Size | 527.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7691819d9da7e8974827db0b5467a331862afc1b453f28a5641c08bd5493e14b
|
|
BLAKE2b-256 checksum How to use checksums |
7dc4358ce5ec8e3cf252bd9d1be68a8c962b74a09f2c117366d93fc98a1ef489
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
