> AI agents: this is one page from Mammoth Analytics documentation. The index of all pages as Markdown is https://mammoth.io/docs/llms.txt. Append `.md` to any docs URL, or send `Accept: text/markdown`, to get Markdown.

# mammoth folder

> All 10 mammoth folder commands with examples, arguments and confirmation flags.

> 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](https://mammoth.io/docs/build/cli/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 |
|---|---|---|---|
| [`folder bulk-delete`](#mammoth-folder-bulk-delete) | Permanently delete several folders by id. Prompt or '--yes' required. | Destructive | `--yes` or prompt |
| [`folder create`](#mammoth-folder-create) | Create a folder. Name comes from a positional or the 'name' field. | Benign mutation | — |
| [`folder delete`](#mammoth-folder-delete) | Permanently delete one folder by id. Prompt or '--yes' required. | Destructive | `--yes` or prompt |
| [`folder find`](#mammoth-folder-find) | Search folder names for a substring across every visible project. | Read | — |
| [`folder get`](#mammoth-folder-get) | Get one folder by id in the active project. | Read | — |
| [`folder list`](#mammoth-folder-list) | List folders in the active project. | Read | — |
| [`folder move`](#mammoth-folder-move) | Move resources into a target folder in the active project. | Benign mutation | — |
| [`folder root`](#mammoth-folder-root) | Get the root folder of the active project. | Read | — |
| [`folder trash`](#mammoth-folder-trash) | Move one folder to the project trash (reversible). | Benign mutation | — |
| [`folder update`](#mammoth-folder-update) | Rename 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.

```bash
mammoth folder bulk-delete --yes
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `folder_ids` | `--input` field | no | — | `list[int]` |  |
| `check_dependency` | `--input` field | no | — | `bool` |  |
| `remove_contents` | `--input` field | no | — | `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.

```bash
mammoth folder create 'Revenue report'
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `NAME` | positional | no | — | `str` | Name of the new folder; or pass it via the 'name' input field. Or the `name` input field. |
| `name` | `--input` field | no | — | `str` |  |
| `parent_resource_id` | `--input` field | no | — | `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.

```bash
mammoth folder delete 123 --yes
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `FOLDER_ID` | positional | yes | — | `int` | ID of the folder to delete. |
| `check_dependency` | `--input` field | no | `true` | `bool` |  |
| `remove_contents` | `--input` field | no | `true` | `bool` |  |

- **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.

```bash
mammoth folder find reports
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `NAME_SUBSTRING` | positional | yes | — | `str` | Case-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.

```bash
mammoth folder get 123
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `FOLDER_ID` | positional | yes | — | `int` | ID of the folder. |
| `fields` | `--input` field | no | — | `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.

```bash
mammoth folder list
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `fields` | `--input` field | no | — | `str` |  |
| `folder_ids` | `--input` field | no | — | `list[int]` |  |
| `names` | `--input` field | no | — | `list[str]` |  |
| `statuses` | `--input` field | no | — | `list[str]` |  |
| `created_at` | `--input` field | no | — | `str` |  |
| `updated_at` | `--input` field | no | — | `str` |  |
| `created_by` | `--input` field | no | — | `list[str]` |  |
| `limit` | `--input` field | no | `50` | `int` |  |
| `offset` | `--input` field | no | `0` | `int` |  |
| `sort` | `--input` field | no | — | `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.

```bash
mammoth folder move --input '{"resource_ids": [8024], "target_folder_resource_id": "root"}'
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `resource_ids` | `--input` field | no | — | `list[str]` |  |
| `target_folder_resource_id` | `--input` field | no | — | `str` |  |
| `source_folder_resource_id` | `--input` field | no | — | `str` |  |
| `dataset_ids` | `--input` field | no | — | `list[int]` |  |
| `view_ids` | `--input` field | no | — | `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.

```bash
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).

```bash
mammoth folder trash 123
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `FOLDER_ID` | positional | yes | — | `int` | ID 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'.

```bash
mammoth folder update 123 --input '{"name": "Revenue report"}'
```

| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
| `FOLDER_ID` | positional | yes | — | `int` | ID of the folder. |
| `name` | `--input` field | yes | — | `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)

---
Source: https://mammoth.io/docs/build/cli/folder.md · Updated: 2026-11-02
