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

mammoth browse

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.

Browse projects and workspace resources. 9 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
browse ancestorsGet the folder path (root first) down to a folder of the active project.Read—
browse folderBrowse resources inside one folder of the active project.Read—
browse projectBrowse the contents of the active project (datasets, folders).Read—
browse resourceGet one resource of the active project: type, then id, as positionals.Read—
browse resourcesBrowse workspace resources in bulk.Read—
browse rootBrowse resources across all workspaces the caller has access to.Read—
browse searchSearch resources across every project of the workspace (resources v2).Read—
browse workspaceBrowse all resources in the active workspace (projects, datasets, folders).Read—
browse resources bulkGet many resources of the active project by type and id in one go (resources v2).Read—

browse commands

mammoth browse ancestors

Get the folder path (root first) down to a folder of the active project.

mammoth browse ancestors 123
NamePassed asRequiredDefaultTypeNotes
RESOURCE_IDpositionalyes—intThe folder's id, as folder list and browse return it.
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: The folder path (breadcrumb) of a FOLDER of the active project: the chain from the project root down to the folder itself, root first (resources v2). Pass the folder's resource_id from browse resources, not its object id. Any other id answers 404; 0 means the project root and returns an empty path. For a dataset or view, take its parent_resource_id first.
  • Id: browse.ancestors · Result: BrowseAncestorsResult · Backed by: SDK mammoth.api.browse.BrowseAPI.resource_ancestors, API GET /workspaces/{workspace_id}/projects/{project_id}/resources/ancestors (GetResourceAncestors)

mammoth browse folder

Browse resources inside one folder of the active project.

mammoth browse folder 123
NamePassed asRequiredDefaultTypeNotes
FOLDER_IDpositionalyes—intID of the folder.
level--input fieldno2int
fields--input fieldno__minstr
  • Effect: Read, scope profile · Confirmation: none · Pages: single_page
  • Preconditions: Validate level and add continuation only if proven.
  • Id: browse.folder · Result: BrowseFolderResult · Backed by: SDK mammoth.api.browse.BrowseAPI.folder_resources, API GET /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id}/browse (BrowseFolderFolders)

mammoth browse project

Browse the contents of the active project (datasets, folders).

mammoth browse project
NamePassed asRequiredDefaultTypeNotes
fields--input fieldno—str
name--input fieldno—str
browse_type--input fieldno—str
sort--input fieldno—str
offset--input fieldno—int
limit--input fieldno—int
  • Effect: Read, scope profile · Confirmation: none · Pages: offset
  • Preconditions: Some servers answer this with HTTP 500; that is a server error, not server_unavailable.
  • Id: browse.project · Result: BrowseProjectResult · Backed by: SDK mammoth.api.projects.ProjectsAPI.browse, API GET /workspaces/{workspace_id}/projects/{project_id}/browse (BrowseProjectProjects)

mammoth browse resource

Get one resource of the active project: type, then id, as positionals.

mammoth browse resource dataset 123
NamePassed asRequiredDefaultTypeNotes
RESOURCE_TYPEpositionalyes—strResource type, for example dataset or dataview.
OBJECT_IDpositionalyes—intID of the resource within its type.
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: One resource of the project with its full properties (resources v2); name the type, then the id.
  • Id: browse.resource · Result: BrowseResourceResult · Backed by: SDK mammoth.api.browse.BrowseAPI.resource_get, API GET /workspaces/{workspace_id}/projects/{project_id}/resources/{resource_type}/{object_id} (GetResource)

mammoth browse resources

Browse workspace resources in bulk.

mammoth browse resources
NamePassed asRequiredDefaultTypeNotes
parent_type--input fieldno—str
parent_id--input fieldno—int
resource_type--input fieldno—str
search--input fieldno—str
cursor--input fieldno—str
limit--input fieldno—int
sort--input fieldno—str
fields--input fieldno—str
  • Effect: Read, scope profile · Confirmation: none · Pages: cursor
  • Preconditions: One project's resources a cursor page at a time (resources v2): pass next_cursor back as cursor while has_more is true. Optional parent_type and parent_id list inside a folder; resource_type, search, sort and fields narrow the page.
  • Id: browse.resources · Result: BrowseResourcesResult · Backed by: SDK mammoth.api.browse.BrowseAPI.resources_list, API GET /workspaces/{workspace_id}/projects/{project_id}/resources (ListResources)

mammoth browse root

Browse resources across all workspaces the caller has access to.

mammoth browse root
NamePassed asRequiredDefaultTypeNotes
fields--input fieldno—str
name--input fieldno—str
browse_type--input fieldno—str
created_at--input fieldno—str
updated_at--input fieldno—str
sort--input fieldno—str
offset--input fieldno—int
limit--input fieldno—int
ids--input fieldno—str
include_hidden--input fieldno—bool
level--input fieldno—int
permissions--input fieldno—str
  • Effect: Read, scope profile · Confirmation: none
  • Id: browse.root · Result: BrowseRootResult · Backed by: SDK mammoth.api.browse.BrowseAPI.root, API GET /browse (BrowseResources)

Search resources across every project of the workspace (resources v2).

mammoth browse search
NamePassed asRequiredDefaultTypeNotes
search--input fieldno—str
resource_type--input fieldno—str
cursor--input fieldno—str
limit--input fieldno—int
sort--input fieldno—str
fields--input fieldno—str
  • Effect: Read, scope profile · Confirmation: none · Pages: cursor
  • Preconditions: Searches resources across every project you can open in the workspace (resources v2), a cursor page at a time: pass next_cursor back as cursor while has_more is true. search matches names; resource_type (comma-separated), sort and fields narrow the page. Needs no active project. Each dataset hit carries dataset_id (its object_id) and each view hit view_id: pass those, never the tree id.
  • Id: browse.search · Result: BrowseSearchResult · Backed by: SDK mammoth.api.browse.BrowseAPI.resources_search, API GET /workspaces/{workspace_id}/resources (SearchResources)

mammoth browse workspace

Browse all resources in the active workspace (projects, datasets, folders).

mammoth browse workspace
NamePassed asRequiredDefaultTypeNotes
level--input fieldno2int
fields--input fieldno__minstr
limit--input fieldno100int
  • Effect: Read, scope profile · Confirmation: none · Pages: single_page
  • Preconditions: Validate level against the OpenAPI enum and report truncation.
  • Id: browse.workspace · Result: BrowseWorkspaceResult · Backed by: SDK mammoth.api.browse.BrowseAPI.workspace_resources, API GET /workspaces/{workspace_id}/browse (BrowseWorkspaceWorkspaces)

browse resources

mammoth browse resources bulk

Get many resources of the active project by type and id in one go (resources v2).

mammoth browse resources bulk --input '{"items": [["dataview", 42]]}'
NamePassed asRequiredDefaultTypeNotes
items--input fieldyes—list[tuple[str, int]]
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Gets many resources of the active project by type and id in one request (resources v2; 100 pairs per request, more are chunked). Pass items in --input as [type, id] pairs, for example [["dataview", 42]]. A pair that does not exist in the project, or that you cannot read, is left out of the answer.
  • Id: browse.resources.bulk · Result: BrowseResourcesBulkResult · Backed by: SDK mammoth.api.browse.BrowseAPI.resources_bulk, API POST /workspaces/{workspace_id}/projects/{project_id}/resources/bulk (BulkGetResources)

Report an issue · support@mammoth.io