mammoth job
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.
Inspect and wait for asynchronous jobs. 4 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 |
|---|---|---|---|
job get | Get one job's status by id. | Read | — |
job get-many | Get status for several jobs by id, from the '--input' document. | Read | — |
job wait | Wait for one job and report success, failure, or still running (15 min default). | Read | — |
job wait-many | Block until several jobs complete, or raise on failure/timeout. | Read | — |
job commands
mammoth job get
Get one job's status by id.
mammoth job get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
JOB_ID | positional | yes | — | int | ID of the job. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: timeout parameter on current get_job is unused and stays visible only for public compatibility.
- Id:
job.get· Result:JobGetResult· Backed by: SDKmammoth.api.jobs.JobsAPI.get_job, APIGET /jobs/{job_id}(GetJob)
mammoth job get-many
Get status for several jobs by id, from the '--input' document.
mammoth job get-many --input '{"job_ids": [1]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
job_ids | --input field | yes | — | list[int] | str | |
timeout | --input field | no | — | float |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: CLI accepts repeatable positive integers, not comma strings.
- Id:
job.get-many· Result:JobGetManyResult· Backed by: SDKmammoth.api.jobs.JobsAPI.get_jobs, APIGET /jobs(GetJobs)
mammoth job wait
Wait for one job and report success, failure, or still running (15 min default).
mammoth job wait 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
JOB_ID | positional | yes | — | int | ID of the job. |
timeout | --input field | no | — | float | |
poll_interval | --input field | no | — | float | |
fetch | --input field | no | — | Callable[[int, float], Awaitable[dict[str, Any]]] | |
dashboard_url | --input field | no | — | str |
- Effect: Read, scope
profile· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: On success, outcome is the state of what the job acted on: a view run gives the view (rows, cols, columns, status, pipeline_running) from one read, a project copy gives datasets, views, skipped and runs (ok, failed with each error, pending) from the job itself. No view get or view analyze is needed after it. A view that cannot be read is outcome_error, not a failed wait.
- Id:
job.wait· Result:JobWaitResult
mammoth job wait-many
Block until several jobs complete, or raise on failure/timeout.
mammoth job wait-many --input '{"job_ids": [1]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
job_ids | --input field | yes | — | list[int] | str | |
timeout | --input field | no | — | int | |
poll_interval | --input field | no | 2 | int |
- Effect: Read, scope
profile· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Reject empty IDs; do not succeed when the server omits a requested job.
- Id:
job.wait-many· Result:JobWaitManyResult