enhancedocs
For agentsOpen Enhance ↗
CLI commands / enhance-dev recording append-chunk

Enhance documentation

enhance-dev recording append-chunk

Commit metadata for the uploaded DOM chunk at this index, then reserve the next upload.

↓ Markdown

enhance-dev recording append-chunk

enhance-dev recording append-chunk [options]

Arguments

This command takes no positional arguments.

Options

OptionRequiredDefaultMeaning
--recording-id <string>YesNoneRecording id, from enhance recording list or recording start.
--index <number>YesNoneZero-based chunk index expected by the current recording upload.
--first-event-ms <number>YesNoneEarliest event offset in this DOM chunk, in milliseconds.
--last-event-ms <number>YesNoneLatest event offset in this DOM chunk, in milliseconds.
--event-count <number>YesNoneNumber of events that begin in this DOM chunk; zero is valid.
--continues [boolean]NofalseTrue when the first byte continues an event begun in the previous DOM chunk.
--bytes <number>YesNoneExact byte length of the content uploaded through the signed URL.
--etag [string]NoNoneETag from the already-uploaded chunk at --index; omit only when abandoning that range.
--json <json>NoNoneComplete procedure input as JSON; do not combine it with field flags.
--client-token <uuid>NoNoneStable UUID to reuse when retrying the exact same mutation.

Input

This command presents the capability recording.appendChunk. It has write effect and single idempotency.

Show complete input JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"recordingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstEventMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastEventMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"eventCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"continues":{"default":false,"type":"boolean"},"bytes":{"type":"integer","minimum":1,"maximum":9007199254740991},"etag":{"type":"string","minLength":1,"maxLength":200}},"required":["recordingId","index","firstEventMs","lastEventMs","eventCount","bytes"]}

Output

This command writes JSON records to standard output. Returns a typed recording.appendChunk result from the Enhance API without transport-specific prose.

Show complete output JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"nextChunkIndex":{"type":"integer","minimum":1,"maximum":9007199254740991},"upload":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["url","expiresAt","headers"],"additionalProperties":false}},"required":["nextChunkIndex","upload"],"additionalProperties":false}

Examples

enhance-dev recording append-chunk --recording-id <string> --index <number> --first-event-ms <number> --last-event-ms <number> --event-count <number> --bytes <number>
Show example input
{
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "index": 0,
 "firstEventMs": 0,
 "lastEventMs": 0,
 "eventCount": 0,
 "bytes": 1
}
Show example output
{
 "nextChunkIndex": 1,
 "upload": {
  "url": "https://example.test/path",
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "headers": {}
 }
}

Exit behaviour

Exit codeMeaning
0The command succeeded.
1The command failed for another reason (INTERNAL). A write may have an unknown outcome.
2The command line was malformed. Nothing ran.
3The API refused the input (BAD_REQUEST).
4The credential is missing or expired (UNAUTHORIZED).
5The API refused the request (FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED).
6A batch finished only in part. Retry with the same --client-token.

Versions

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.