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

mammoth folder

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.

Create, rename, move and delete project folders that organize datasets, views and dashboards. To upload a local directory use 'file upload-folder'. 10 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

CommandWhat it doesEffectConfirmation
folder bulk-deletePermanently delete several folders by id. Prompt or '--yes' required.Destructive--yes or prompt
folder createCreate a folder. Name comes from a positional or the 'name' field.Benign mutation—
folder deletePermanently delete one folder by id. Prompt or '--yes' required.Destructive--yes or prompt
folder findSearch folder names for a substring across every visible project.Read—
folder getGet one folder by id in the active project.Read—
folder listList folders in the active project.Read—
folder moveMove resources into a target folder in the active project.Benign mutation—
folder rootGet the root folder of the active project.Read—
folder trashMove one folder to the project trash (reversible).Benign mutation—
folder updateRename a folder. Folder id is positional; new name comes from '--input'.Benign mutation—

folder commands

mammoth folder bulk-delete

Permanently delete several folders by id. Prompt or '--yes' required.

mammoth folder bulk-delete --yes
NamePassed asRequiredDefaultTypeNotes
folder_ids--input fieldno—list[int]
check_dependency--input fieldno—bool
remove_contents--input fieldno—bool
  • Effect: Destructive, scope project · Confirmation: --yes, or answer the prompt at an interactive terminal
  • Preconditions: Deletes every listed folder for good and cannot be undone. List them first (folder list). Needs a prompt or --yes.
  • Id: folder.bulk-delete · Result: FolderBulkDeleteResult · Backed by: SDK mammoth.api.folders.FoldersAPI.bulk_delete, API DELETE /workspaces/{workspace_id}/projects/{project_id}/folders (DeleteFolders)

mammoth folder create

Create a folder. Name comes from a positional or the 'name' field.

mammoth folder create 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new folder; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
parent_resource_id--input fieldno—str
  • Effect: Benign mutation, scope project · Confirmation: none
  • Id: folder.create · Result: FolderCreateResult · Backed by: SDK mammoth.api.folders.FoldersAPI.create, API POST /workspaces/{workspace_id}/projects/{project_id}/folders (CreateFolder)

mammoth folder delete

Permanently delete one folder by id. Prompt or '--yes' required.

mammoth folder delete 123 --yes
NamePassed asRequiredDefaultTypeNotes
FOLDER_IDpositionalyes—intID of the folder to delete.
check_dependency--input fieldnotruebool
remove_contents--input fieldnotruebool
  • Effect: Destructive, scope project · Confirmation: --yes, or answer the prompt at an interactive terminal
  • Preconditions: Sorted ID-set confirmation, plus exact project ID and phrase DELETE FOLDER CONTENTS when removing contents.
  • Id: folder.delete · Result: FolderDeleteResult · Backed by: SDK mammoth.api.folders.FoldersAPI.delete, API DELETE /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id} (DeleteFolder)

mammoth folder find

Search folder names for a substring across every visible project.

mammoth folder find reports
NamePassed asRequiredDefaultTypeNotes
NAME_SUBSTRINGpositionalyes—strCase-insensitive substring to match against folder names.
  • Effect: Read, scope project · Confirmation: none
  • Preconditions: Required inputs: NAME_SUBSTRING.
  • Id: folder.find · Result: FolderFindResult

mammoth folder get

Get one folder by id in the active project.

mammoth folder get 123
NamePassed asRequiredDefaultTypeNotes
FOLDER_IDpositionalyes—intID of the folder.
fields--input fieldno—str
  • Effect: Read, scope project · Confirmation: none
  • Preconditions: Required inputs: FOLDER_ID.
  • Id: folder.get · Result: FolderGetResult · Backed by: SDK mammoth.api.folders.FoldersAPI.get, API GET /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id} (GetFolder)

mammoth folder list

List folders in the active project.

mammoth folder list
NamePassed asRequiredDefaultTypeNotes
fields--input fieldno—str
folder_ids--input fieldno—list[int]
names--input fieldno—list[str]
statuses--input fieldno—list[str]
created_at--input fieldno—str
updated_at--input fieldno—str
created_by--input fieldno—list[str]
limit--input fieldno50int
offset--input fieldno0int
sort--input fieldno—str
  • Effect: Read, scope project · Confirmation: none · Pages: offset
  • Id: folder.list · Result: FolderListResult · Backed by: SDK mammoth.api.folders.FoldersAPI.list, API GET /workspaces/{workspace_id}/projects/{project_id}/folders (ListFolders)

mammoth folder move

Move resources into a target folder in the active project.

mammoth folder move --input '{"resource_ids": [8024], "target_folder_resource_id": "root"}'
NamePassed asRequiredDefaultTypeNotes
resource_ids--input fieldno—list[str]
target_folder_resource_id--input fieldno—str
source_folder_resource_id--input fieldno—str
dataset_ids--input fieldno—list[int]
view_ids--input fieldno—list[int]
  • Effect: Benign mutation, scope project · Confirmation: none · Waits: returns a job id at once; follow it with mammoth job wait
  • Preconditions: Prefer dataset_ids/view_ids (the plain ids dataset get/view get return) over resource_ids -- the SDK resolves them to resource ids for you. resource_ids itself takes each item's resource id, not a dataset/view's own id. target_folder_resource_id is the destination folder's id, exactly as folder list/folder get/folder create return it (the id the web app opens the folder by).
  • Id: folder.move · Result: FolderMoveResult · Backed by: SDK mammoth.api.folders.FoldersAPI.move, API PATCH /workspaces/{workspace_id}/projects/{project_id}/folders (UpdateFolderResources)

mammoth folder root

Get the root folder of the active project.

mammoth folder root
  • Effect: Read, scope project · Confirmation: none
  • Id: folder.root · Result: FolderRootResult

mammoth folder trash

Move one folder to the project trash (reversible).

mammoth folder trash 123
NamePassed asRequiredDefaultTypeNotes
FOLDER_IDpositionalyes—intID of the folder.
  • Effect: Benign mutation, scope project · Confirmation: none · Waits: waits for the job to finish (--job-timeout, --return-running)
  • Preconditions: Required inputs: FOLDER_ID.
  • Id: folder.trash · Result: FolderTrashResult · Backed by: SDK mammoth.api.folders.FoldersAPI.trash, API POST /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id}/trash (TrashFolder)

mammoth folder update

Rename a folder. Folder id is positional; new name comes from '--input'.

mammoth folder update 123 --input '{"name": "Revenue report"}'
NamePassed asRequiredDefaultTypeNotes
FOLDER_IDpositionalyes—intID of the folder.
name--input fieldyes—str
  • Effect: Benign mutation, scope project · Confirmation: none
  • Preconditions: Required inputs: FOLDER_ID.
  • Id: folder.update · Result: FolderUpdateResult · Backed by: SDK mammoth.api.folders.FoldersAPI.update, API PATCH /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id} (UpdateFolderDetails)

Report an issue · support@mammoth.io