timeline.rebase · Umwelt docs

Reference/Commands/timeline.rebase

timeline.rebasecommandsince 0.1

Replays an active draft on top of its parent’s current head.

Command lineTypeScript.NET

Request

umwelt call story.umw timeline.rebase '{
  "projectId": "ball",
  "timelineId": "chapter-2"
}'

Request

const result = await client.timelineRebase({ projectId: 'ball', timelineId: 'chapter-2' });

Request

var result = engine.TimelineRebase(new TimelineRef { ProjectId = "ball", TimelineId = "chapter-2" });

Response

{
  "kind": "draft",
  "id": "chapter-2",
  "status": "active",
  "projectId": "ball",
  "label": "Chapter 2",
  "baseVersion": 16,
  "createdAt": "2026-11-11T18:21:58.6687174Z",
  "depth": 1,
  "headVersion": 17,
  "maxTick": 11,
  "parentTimelineId": "main"
}

Payload

Field	Type	Description
`projectId`required	string	The project to write to.
`timelineId`required	stringdefault "main"	The timeline to write to.

Result

Field	Type	Description
`id`always	string	The timeline’s id. Main is always `main`.
`projectId`always	string	The project it belongs to.
`kind`always	"main" \| "draft"	`main` or `draft`.
`status`always	"active" \| "promoted" \| "discarded"	`active`, `promoted` or `discarded`. Only an active timeline accepts writes.
`label`	string	Its label.
`parentTimelineId`	string	The timeline it branched from: `main` or another draft. Absent for main.
`depth`always	integer	Drafts from main down to it: 0 for main, 1 for a draft of main, at most 4.
`baseVersion`	integer	The parent’s head when it was opened. Absent for main.
`headVersion`always	integer	The version of its latest commit, or its base when it has none.
`maxTick`always	integer	The highest tick it sees.
`createdAt`always	string	When it was opened (UTC).
`closedAt`	string	When it was promoted or discarded.
`purgedAt`	string	When its rows were purged.

Rules

All of it or nothing. Every commit is validated and applied again with new versions. If one no longer fits, nothing changes and the error names it.

Ids stay. Commits keep their ids and attempt ids; events keep their positions on every axis; documents keep their vectors.

No meaning is resolved. If the parent and the draft now disagree, both are kept and contradictions reports it.

Errors

VALIDATION_FAILEDA commit no longer fits. details has failedAttemptId, failedEventId and cause.

NOT_FOUNDThe project or draft does not exist.

INVALID_STATEThe draft is not active, or other drafts depend on it (details.descendants).

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also