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

mammoth schedule

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

CommandWhat it doesEffectConfirmation
schedule createCreate a schedule. The required 'spec' field comes from '--input'.External effect--yes
schedule deleteDelete one schedule by id. Prompt or '--yes' required.Destructive--yes or prompt
schedule getGet one schedule by id in the active project.Read—
schedule listRetired: the server does not implement listing a project's schedules.Read—
schedule updateApply 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
NamePassed asRequiredDefaultTypeNotes
spec--input fieldyes—ScheduleCreateSpec
  • Effect: External effect, scope project · Confirmation: always --yes, even at a terminal
  • Id: schedule.create · Result: ScheduleCreateResult · Backed by: SDK mammoth.api.schedules.SchedulesAPI.create, API POST /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
NamePassed asRequiredDefaultTypeNotes
SCHEDULE_IDpositionalyes—intID 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: SDK mammoth.api.schedules.SchedulesAPI.delete, API DELETE /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
NamePassed asRequiredDefaultTypeNotes
SCHEDULE_IDpositionalyes—intID of the schedule.
  • Effect: Read, scope project · Confirmation: none
  • Preconditions: Required inputs: SCHEDULE_ID.
  • Id: schedule.get · Result: ScheduleGetResult · Backed by: SDK mammoth.api.schedules.SchedulesAPI.get, API GET /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
NamePassed asRequiredDefaultTypeNotes
limit--input fieldno50int
offset--input fieldno0int
  • 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_ID with an id obtained elsewhere.
  • Id: schedule.list · Result: ScheduleListResult · Backed by: SDK mammoth.api.schedules.SchedulesAPI.list, API GET /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
NamePassed asRequiredDefaultTypeNotes
SCHEDULE_IDpositionalyes—intID of the schedule.
patch--input fieldyes—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: SDK mammoth.api.schedules.SchedulesAPI.update, API PATCH /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id} (PatchSchedule)

Report an issue · support@mammoth.io