mammoth schedule
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.
Manage scheduled work. 5 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 |
|---|---|---|---|
schedule create | Create a schedule. The required 'spec' field comes from '--input'. | External effect | --yes |
schedule delete | Delete one schedule by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
schedule get | Get one schedule by id in the active project. | Read | — |
schedule list | Retired: the server does not implement listing a project's schedules. | Read | — |
schedule update | Apply JSON-patch operations to one schedule. Always requires '--yes'. | External effect | --yes |
schedule commands
mammoth schedule create
Create a schedule. The required 'spec' field comes from '--input'.
mammoth schedule create --input '{"spec": {"rrule": {"frequency": "minutely", "start": "2026-01-01T00:00:00Z"}}}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
spec | --input field | yes | — | ScheduleCreateSpec |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Id:
schedule.create· Result:ScheduleCreateResult· Backed by: SDKmammoth.api.schedules.SchedulesAPI.create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/schedules(CreateSchedule)
mammoth schedule delete
Delete one schedule by id. Prompt or '--yes' required.
mammoth schedule delete 123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SCHEDULE_ID | positional | yes | — | int | ID of the schedule. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Immutable ID confirmation.
- Id:
schedule.delete· Result:ScheduleDeleteResult· Backed by: SDKmammoth.api.schedules.SchedulesAPI.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id}(DeleteSchedule)
mammoth schedule get
Get one schedule by id in the active project.
mammoth schedule get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SCHEDULE_ID | positional | yes | — | int | ID of the schedule. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: SCHEDULE_ID.
- Id:
schedule.get· Result:ScheduleGetResult· Backed by: SDKmammoth.api.schedules.SchedulesAPI.get, APIGET /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id}(GetSchedule)
mammoth schedule list
Retired: the server does not implement listing a project's schedules.
mammoth schedule list
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
limit | --input field | no | 50 | int | |
offset | --input field | no | 0 | int |
- Effect: Read, scope
project· Confirmation: none · Pages:offset - Preconditions: Retired: the command answers not_available and names the web app. No Mammoth server can list schedules for a project (GET answers HTTP 400 NOT_IMPLEMENTED), so do not poll it. Use
schedule get SCHEDULE_IDwith an id obtained elsewhere. - Id:
schedule.list· Result:ScheduleListResult· Backed by: SDKmammoth.api.schedules.SchedulesAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/schedules(ListSchedules)
mammoth schedule update
Apply JSON-patch operations to one schedule. Always requires '--yes'.
mammoth schedule update 123 --input '{"patch": [{"op": "replace", "path": "rrule", "value": {"rrule": {"frequency": "minutely", "start": "2026-01-01T00:00:00Z"}, "work_items": [{"name": "pull_cloud_data", "execution_params": {"schedule_type": "moment", "first_pull_at": "now", "on_refresh_action": "replace"}, "args": [1]}]}}]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SCHEDULE_ID | positional | yes | — | int | ID of the schedule. |
patch | --input field | yes | — | list[SchedulePatchItem] |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: status=resume requires exact ID confirmation.
- Id:
schedule.update· Result:ScheduleUpdateResult· Backed by: SDKmammoth.api.schedules.SchedulesAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id}(PatchSchedule)