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

mammoth parameter

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.

Manage parameters and parameter groups. 14 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
parameter createCreate a parameter. Name comes from a positional or the 'name' field.Benign mutation—
parameter deletePermanently delete one parameter by id. Prompt or '--yes' required.Destructive--yes or prompt
parameter dependenciesReport what depends on one parameter by id.Read—
parameter duplicateDuplicate one parameter by id.Benign mutation—
parameter getGet one parameter by id.Read—
parameter listList parameters, optionally filtered and scoped to a project.Read—
parameter rerunRerun one parameter's computation by id.Benign mutation—
parameter rerun-all-staleRerun every stale parameter in the active project.Benign mutation—
parameter updateUpdate a parameter. Parameter id is positional; fields come from '--input'.Benign mutation—
parameter group createCreate a parameter group. Name comes from a positional or the 'name' field.Benign mutation—
parameter group deletePermanently delete one parameter group by id. Prompt or '--yes' required.Destructive--yes or prompt
parameter group listList parameter groups, optionally scoped to a project.Read—
parameter group reorderReorder parameter groups. 'order' (a list of group ids) is required.Benign mutation—
parameter group updateUpdate a parameter group. Group id is positional; fields come from '--input'.Benign mutation—

parameter commands

mammoth parameter create

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

mammoth parameter create revenue_report --input '{"param_type": "TEXT", "value": "Q3"}'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new parameter; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
param_type--input fieldyes—str
value--input fieldyes—str | float | int
description--input fieldno—str
group_id--input fieldno—int
scope--input fieldnoprojectstr
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Preconditions: param_type is NUMERIC, TEXT or DATE (uppercase; 4PARM008 otherwise).
  • Id: parameter.create · Result: ParameterCreateResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.create, API POST /workspaces/{workspace_id}/parameters (CreateParameter)

mammoth parameter delete

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

mammoth parameter delete 123 --yes
NamePassed asRequiredDefaultTypeNotes
PARAMETER_IDpositionalyes—intID of the parameter.
  • Effect: Destructive, scope profile · Confirmation: --yes, or answer the prompt at an interactive terminal
  • Preconditions: Required inputs: PARAMETER_ID.
  • Id: parameter.delete · Result: ParameterDeleteResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.delete, API DELETE /workspaces/{workspace_id}/parameters/{parameter_id} (DeleteParameter)

mammoth parameter dependencies

Report what depends on one parameter by id.

mammoth parameter dependencies 123
NamePassed asRequiredDefaultTypeNotes
PARAMETER_IDpositionalyes—intID of the parameter.
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Required inputs: PARAMETER_ID.
  • Id: parameter.dependencies · Result: ParameterDependenciesResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.dependencies, API GET /workspaces/{workspace_id}/parameters/{parameter_id}/dependencies (GetParameterDependencies)

mammoth parameter duplicate

Duplicate one parameter by id.

mammoth parameter duplicate 123
NamePassed asRequiredDefaultTypeNotes
PARAMETER_IDpositionalyes—intID of the parameter.
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Preconditions: Required inputs: PARAMETER_ID.
  • Id: parameter.duplicate · Result: ParameterDuplicateResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.duplicate, API POST /workspaces/{workspace_id}/parameters/{parameter_id}/duplicate (DuplicateParameter)

mammoth parameter get

Get one parameter by id.

mammoth parameter get 123
NamePassed asRequiredDefaultTypeNotes
PARAMETER_IDpositionalyes—intID of the parameter.
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Required inputs: PARAMETER_ID.
  • Id: parameter.get · Result: ParameterGetResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.get, API GET /workspaces/{workspace_id}/parameters/{parameter_id} (GetParameterDetail)

mammoth parameter list

List parameters, optionally filtered and scoped to a project.

mammoth parameter list
NamePassed asRequiredDefaultTypeNotes
limit--input fieldno—int
offset--input fieldno—int
search--input fieldno—str
group_id--input fieldno—int
sort--input fieldno—str
  • Effect: Read, scope profile · Confirmation: none · Pages: single_page
  • Id: parameter.list · Result: ParameterListResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.list, API GET /workspaces/{workspace_id}/parameters (ListParameters)

mammoth parameter rerun

Rerun one parameter's computation by id.

mammoth parameter rerun 123
NamePassed asRequiredDefaultTypeNotes
PARAMETER_IDpositionalyes—intID of the parameter.
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Preconditions: A filter bound to a parameter can stay pending after the call returns; check verify.outcome and run mammoth view pipeline wait VIEW_ID before reading the view.
  • Id: parameter.rerun · Result: ParameterRerunResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.rerun, API POST /workspaces/{workspace_id}/parameters/{parameter_id}/rerun (RerunParameter)

mammoth parameter rerun-all-stale

Rerun every stale parameter in the active project.

mammoth parameter rerun-all-stale
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Preconditions: A filter bound to a parameter can stay pending after the call returns; check verify.outcome and run mammoth view pipeline wait VIEW_ID before reading the view.
  • Id: parameter.rerun-all-stale · Result: ParameterRerunAllStaleResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.rerun_all_stale, API POST /workspaces/{workspace_id}/parameters/rerun-all-stale (RerunAllStale)

mammoth parameter update

Update a parameter. Parameter id is positional; fields come from '--input'.

mammoth parameter update 123
NamePassed asRequiredDefaultTypeNotes
PARAMETER_IDpositionalyes—intID of the parameter.
name--input fieldno—str
value--input fieldno—str | float | int | None
param_type--input fieldno—str
description--input fieldno—str
group_id--input fieldno—int
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Preconditions: A filter bound to a parameter can stay pending after the call returns; check verify.outcome and run mammoth view pipeline wait VIEW_ID before reading the view.
  • Id: parameter.update · Result: ParameterUpdateResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.update, API PATCH /workspaces/{workspace_id}/parameters/{parameter_id} (UpdateParameter)

parameter group

mammoth parameter group create

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

mammoth parameter group create 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new parameter group; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
color--input fieldno#3B82F6str
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Id: parameter.group.create · Result: ParameterGroupCreateResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.group_create, API POST /workspaces/{workspace_id}/parameters/groups (CreateGroup)

mammoth parameter group delete

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

mammoth parameter group delete 123 --yes
NamePassed asRequiredDefaultTypeNotes
GROUP_IDpositionalyes—intID of the group.
  • Effect: Destructive, scope profile · Confirmation: --yes, or answer the prompt at an interactive terminal
  • Preconditions: Required inputs: GROUP_ID.
  • Id: parameter.group.delete · Result: ParameterGroupDeleteResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.group_delete, API DELETE /workspaces/{workspace_id}/parameters/groups/{group_id} (DeleteGroup)

mammoth parameter group list

List parameter groups, optionally scoped to a project.

mammoth parameter group list
NamePassed asRequiredDefaultTypeNotes
limit--input fieldno—int
offset--input fieldno—int
sort--input fieldno—str
  • Effect: Read, scope profile · Confirmation: none · Pages: single_page
  • Id: parameter.group.list · Result: ParameterGroupListResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.group_list, API GET /workspaces/{workspace_id}/parameters/groups (ListGroups)

mammoth parameter group reorder

Reorder parameter groups. 'order' (a list of group ids) is required.

mammoth parameter group reorder --input '{"order": [1]}'
NamePassed asRequiredDefaultTypeNotes
order--input fieldyes—list[int]
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Id: parameter.group.reorder · Result: ParameterGroupReorderResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.group_reorder, API POST /workspaces/{workspace_id}/parameters/groups/reorder (ReorderGroups)

mammoth parameter group update

Update a parameter group. Group id is positional; fields come from '--input'.

mammoth parameter group update 123
NamePassed asRequiredDefaultTypeNotes
GROUP_IDpositionalyes—intID of the group.
name--input fieldno—str
color--input fieldno—str
  • Effect: Benign mutation, scope profile · Confirmation: none
  • Preconditions: Required inputs: GROUP_ID.
  • Id: parameter.group.update · Result: ParameterGroupUpdateResult · Backed by: SDK mammoth.api.parameters.ParametersAPI.group_update, API PATCH /workspaces/{workspace_id}/parameters/groups/{group_id} (UpdateGroup)

Report an issue · support@mammoth.io