Skip to main content

Command-line interface for the Mammoth Analytics platform

Project description

mammoth-cli

Drive the Mammoth Analytics platform from your terminal. The mammoth command uploads data, runs pipeline transformations, manages projects and dashboards, and exports results — for people at a shell and for autonomous agents alike.

PyPI Python License

  • 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.
  • Safe. Every mutation carries a reviewed confirmation policy, so a destructive command never runs unattended by accident.
  • 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.

Install

uv tool install mammoth-cli      # recommended: isolated, on your PATH
# or
pipx install mammoth-cli
# or
python -m pip install mammoth-cli

Then confirm the install:

mammoth --version

The CLI supports Python 3.12, 3.13, and 3.14. For the one-line installers and the verified (signed) install flow, see docs/installation.md.

Quick start

mammoth auth login -w 4          # log in once; the secret goes to your OS keyring
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.

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"}'

Install the bundled agent skill for Claude Code, Codex, and Cursor:

mammoth skill install

See docs/agents.md and the agent skill.

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.

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 (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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mammoth_cli-1.0.3.tar.gz (406.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mammoth_cli-1.0.3-py3-none-any.whl (509.2 kB view details)

Uploaded Python 3

File details

Details for the file mammoth_cli-1.0.3.tar.gz.

File metadata

  • Download URL: mammoth_cli-1.0.3.tar.gz
  • Upload date:
  • Size: 406.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for mammoth_cli-1.0.3.tar.gz
Algorithm Hash digest
SHA256 d136282fc2115940cda470be582c61d5d4e8921c92da1acf0b9edf82d41e93b7
MD5 868e6bb11760e87966a7676b9221dade
BLAKE2b-256 699979ec61998cf2ae5f36281ac59ca25041eeda0562917e214b10a111f207ba

See more details on using hashes here.

File details

Details for the file mammoth_cli-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: mammoth_cli-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 509.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for mammoth_cli-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fbf171df90a9d10e86b2d5c7c07971ef035540c5a27c941783287aa98918b2c2
MD5 5d3749f366ddc63f59ea6449bffa3883
BLAKE2b-256 22a60a1b3c8674b5fd7f5ce72ef961cd138efb2887331d47223c891e472e2ec7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page