mammoth collection
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.
Group dashboards into a collection and share the set as one. 21 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 |
|---|---|---|---|
collection active-job | Show the collection's upload job still in flight. Collection id is positional. | Read | — |
collection activity | Show who opened a collection and which of its dashboards get opened. | Read | — |
collection create | Create a collection in the active project. Name comes from '--input'. | Benign mutation | — |
collection delete | Delete a collection and end its members' access through it. | Destructive | --yes or prompt |
collection for-dashboard | List the collections that hold a dashboard. Dashboard id is positional. | Read | — |
collection get | Get one collection with its dashboards, members and refresh setup. | Read | — |
collection get-by-url | Open a collection by its share url token, as a viewer does. | Read | — |
collection job | Poll one collection upload job. Collection id and job id are positional. | Read | — |
collection list | List the collections you manage or were shared. | Read | — |
collection pipeline-changes | Show the progress of a collection's data refresh. | Read | — |
collection share | Give people access to a collection by email and send them the invite. | External effect | --yes |
collection update | Change a collection's name, description, dashboard order or tab labels. | Benign mutation | — |
collection dashboards add | Add dashboards to a collection, which gives its members access to them. | External effect | --yes |
collection dashboards remove | Take one dashboard out of a collection; the dashboard is kept. | Destructive | --yes or prompt |
collection email-updates get | Get a collection's email updates: schedule, people, unsubscribed and a preview. | Read | — |
collection email-updates me get | Get whether the caller receives a collection's email updates. | Read | — |
collection email-updates me set | Turn the caller's own email updates for a collection on, or off. | Benign mutation | — |
collection email-updates set | Turn a collection's email updates on or off, or change them. Managers only. | External effect | --yes |
collection email-updates test | Send one test email update to the caller, with the numbers an editor sees. | External effect | --yes |
collection files upload | Upload local files to refresh a collection's data. Paths come from '--input'. | Benign mutation | — |
collection members remove | Take one person off a collection by email. | Destructive | --yes or prompt |
collection commands
mammoth collection active-job
Show the collection's upload job still in flight. Collection id is positional.
mammoth collection active-job 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. Returns the collection's upload job that is still in flight, so an interrupted upload can be resumed. Use collection job to poll one job by id.
- Id:
collection.active-job· Result:CollectionActiveJobResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.active_job, APIGET /collections/{collection_id}/active-job(ActiveJob)
mammoth collection activity
Show who opened a collection and which of its dashboards get opened.
mammoth collection activity 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. Who opened the collection and which of its dashboards get opened: opened, member_count, people (email, status, last_opened_at) and dashboards (views, viewers).
- Id:
collection.activity· Result:CollectionActivityResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.activity, APIGET /collections/{collection_id}/activity(CollectionActivity)
mammoth collection create
Create a collection in the active project. Name comes from '--input'.
mammoth collection create --input '{"name": "Revenue report"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
name | --input field | yes | — | str | |
description | --input field | no | — | str | |
dashboard_ids | --input field | no | — | list[int] |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: Creates a collection in the active project (--project, or input project_id). name is 1 to 120 characters; dashboard_ids puts boards in it, in order. Nobody else sees it until collection share.
- Id:
collection.create· Result:CollectionCreateResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.create, APIPOST /collections(CreateCollection)
mammoth collection delete
Delete a collection and end its members' access through it.
mammoth collection delete 123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: Destructive, scope
profile· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Deletes the collection and ends every member's access through it. The dashboards in it are kept.
- Id:
collection.delete· Result:CollectionDeleteResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.delete, APIDELETE /collections/{collection_id}(DeleteCollection)
mammoth collection for-dashboard
List the collections that hold a dashboard. Dashboard id is positional.
mammoth collection for-dashboard 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. The collections that hold this dashboard, in the shape collection list returns.
- Id:
collection.for-dashboard· Result:CollectionForDashboardResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.for_dashboard, APIGET /collections/for-dashboard/{dashboard_id}(CollectionsForDashboard)
mammoth collection get
Get one collection with its dashboards, members and refresh setup.
mammoth collection get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. One collection with its dashboards in order, its members (managers only), and its refresh setup.
- Id:
collection.get· Result:CollectionGetResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.get, APIGET /collections/{collection_id}(GetCollection)
mammoth collection get-by-url
Open a collection by its share url token, as a viewer does.
mammoth collection get-by-url https://example.com/data.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
t | --input field | no | — | str | |
email | --input field | no | — | str |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. Opens a collection by its share url token, as a viewer does. Input t is the invite token, which the server redeems on the way in; email is the address the invite went to.
- Id:
collection.get-by-url· Result:CollectionGetByUrlResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.get_by_url, APIGET /collections/url/{url}(GetCollectionByUrl)
mammoth collection job
Poll one collection upload job. Collection id and job id are positional.
mammoth collection job 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
JOB_ID | positional | yes | — | int | ID of the job. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. Polls one collection upload job by id and returns its state.
- Id:
collection.job· Result:CollectionJobResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.job, APIGET /collections/{collection_id}/jobs/{job_id}(GetRefreshJob)
mammoth collection list
List the collections you manage or were shared.
mammoth collection list
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. The collections you manage or were shared, each with its role (manager or member), url, project and dashboard count.
- Id:
collection.list· Result:CollectionListResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.list, APIGET /collections(ListCollections)
mammoth collection pipeline-changes
Show the progress of a collection's data refresh.
mammoth collection pipeline-changes 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Read-only. Progress of the collection's data refresh; empty when no automation is linked.
- Id:
collection.pipeline-changes· Result:CollectionPipelineChangesResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.pipeline_changes, APIGET /collections/{collection_id}/pipeline-changes(PipelineChanges)
mammoth collection share
Give people access to a collection by email and send them the invite.
mammoth collection share 123 --input '{"emails": ["analyst@example.com"]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
emails | --input field | yes | — | list[str] |
- Effect: External effect, scope
profile· Confirmation: always--yes, even at a terminal - Preconditions: Gives people access to the collection by email and sends them the invite. The result lists added, already (members before) and in_project (skipped: they already edit the project's boards). Always needs --yes.
- Id:
collection.share· Result:CollectionShareResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.share, APIPOST /collections/{collection_id}/share(ShareCollection)
mammoth collection update
Change a collection's name, description, dashboard order or tab labels.
mammoth collection update 123 --input '{"name": "Q3 pack"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
name | --input field | no | — | str | |
description | --input field | no | — | str | |
order | --input field | no | — | list[int] | |
tab_labels | --input field | no | — | dict[str, str | None] | |
automation_id | --input field | no | — | int | |
unlink_automation | --input field | no | false | bool |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: Changes only the fields given: name, description, order (every dashboard id, in the new order), tab_labels (dashboard id to a short label; empty clears it), automation_id to link the upload-to-refresh automation, or unlink_automation.
- Id:
collection.update· Result:CollectionUpdateResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.update, APIPATCH /collections/{collection_id}(UpdateCollection)
collection dashboards
mammoth collection dashboards add
Add dashboards to a collection, which gives its members access to them.
mammoth collection dashboards add 123 --input '{"dashboard_ids": [1]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
dashboard_ids | --input field | yes | — | list[int] | |
notify | --input field | no | false | bool |
- Effect: External effect, scope
profile· Confirmation: always--yes, even at a terminal - Preconditions: Adds dashboards to the collection, which gives its members access to them. notify true also emails the members. Always needs --yes.
- Id:
collection.dashboards.add· Result:CollectionDashboardsAddResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.add_dashboards, APIPOST /collections/{collection_id}/dashboards(AddDashboards)
mammoth collection dashboards remove
Take one dashboard out of a collection; the dashboard is kept.
mammoth collection dashboards remove 123 456 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Destructive, scope
profile· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Takes one dashboard out of the collection. The dashboard is kept.
- Id:
collection.dashboards.remove· Result:CollectionDashboardsRemoveResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.remove_dashboard, APIDELETE /collections/{collection_id}/dashboards/{dashboard_id}(RemoveDashboard)
collection email-updates
mammoth collection email-updates get
Get a collection's email updates: schedule, people, unsubscribed and a preview.
mammoth collection email-updates get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Required inputs: COLLECTION_ID.
- Id:
collection.email-updates.get· Result:CollectionEmailUpdatesGetResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.email_updates, APIGET /collections/{collection_id}/email-updates(GetCollectionEmailUpdates)
mammoth collection email-updates me get
Get whether the caller receives a collection's email updates.
mammoth collection email-updates me get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Required inputs: COLLECTION_ID.
- Id:
collection.email-updates.me.get· Result:CollectionEmailUpdatesMeGetResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.my_email_updates, APIGET /collections/{collection_id}/email-updates/me(GetMyCollectionEmailUpdates)
mammoth collection email-updates me set
Turn the caller's own email updates for a collection on, or off.
mammoth collection email-updates me set 123 --input '{"subscribed": true}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
subscribed | --input field | yes | — | bool |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: Turns your own email updates for the collection on or off; nobody else's.
- Id:
collection.email-updates.me.set· Result:CollectionEmailUpdatesMeSetResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.set_my_email_updates, APIPUT /collections/{collection_id}/email-updates/me(SetMyCollectionEmailUpdates)
mammoth collection email-updates set
Turn a collection's email updates on or off, or change them. Managers only.
mammoth collection email-updates set 123 --input '{"enabled": true, "timezone": "UTC"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
enabled | --input field | yes | — | bool | |
timezone | --input field | yes | — | str | |
trigger | --input field | no | — | str | |
frequency | --input field | no | — | str | |
weekday | --input field | no | — | int | |
monthday | --input field | no | — | int | |
time_of_day | --input field | no | — | str | |
numbers | --input field | no | — | dict[str, list[str]] |
- Effect: External effect, scope
profile· Confirmation: always--yes, even at a terminal - Preconditions: Saves the collection's email-update schedule and the phone numbers or people it reaches. Needs --yes. Editors only.
- Id:
collection.email-updates.set· Result:CollectionEmailUpdatesSetResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.set_email_updates, APIPUT /collections/{collection_id}/email-updates(SaveCollectionEmailUpdates)
mammoth collection email-updates test
Send one test email update to the caller, with the numbers an editor sees.
mammoth collection email-updates test 123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
- Effect: External effect, scope
profile· Confirmation: always--yes, even at a terminal - Preconditions: Sends a real test email update right away. Needs --yes.
- Id:
collection.email-updates.test· Result:CollectionEmailUpdatesTestResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.send_test_email_update, APIPOST /collections/{collection_id}/email-updates/test(TestCollectionEmailUpdate)
collection files
mammoth collection files upload
Upload local files to refresh a collection's data. Paths come from '--input'.
mammoth collection files upload 123 --input '{"files": ["./sales.csv"]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
files | --input field | yes | — | list[str] | |
append_to_ds_id | --input field | no | — | int |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: Uploads local files to refresh the collection's data. Input files is the list of paths; append_to_ds_id appends to one of the refresh datasets. The server answers with an upload job id and refreshes in the background.
- Id:
collection.files.upload· Result:CollectionFilesUploadResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.upload_files, APIPOST /collections/{collection_id}/files(UploadFile)
collection members
mammoth collection members remove
Take one person off a collection by email.
mammoth collection members remove 123 --input '{"email": "analyst@example.com"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
COLLECTION_ID | positional | yes | — | int | ID of the collection. |
email | --input field | yes | — | str |
- Effect: Destructive, scope
profile· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Takes one person off the collection by email.
- Id:
collection.members.remove· Result:CollectionMembersRemoveResult· Backed by: SDKmammoth.api.collections.CollectionsAPI.remove_member, APIDELETE /collections/{collection_id}/members(RemoveMember)