Enhance documentation
enhance-dev recording complete
Finish a recording and report any missing event or audio chunks.
enhance-dev recording complete
enhance-dev recording complete [options]Arguments
This command takes no positional arguments.
Options
| Option | Required | Default | Meaning |
|---|---|---|---|
--recording-id <string> | Yes | None | Recording id, from enhance recording list or recording start. |
--duration-ms <number> | Yes | None | Total recording duration in milliseconds. |
--viewport [json] | No | None | Viewport JSON, for example {"width":1440,"height":900}. |
--source-url <string> | Yes | None | Original page URL associated with the capture or recording. |
--interrupted [boolean] | No | false | True when capture ended unexpectedly rather than by an ordinary stop. |
--canvas-id [string] | No | None | Existing destination canvas UUID; do not combine with --organisation-id. |
--organisation-id [string] | No | None | Team UUID for a newly created canvas; omit both destination flags for personal. |
--audio-chunk-count [number] | No | 0 | Number of audio chunks the client attempted; zero means no microphone. |
--has-recoverable-bytes [boolean] | No | false | True when exact bytes for at least one missing chunk were retained. |
--json <json> | No | None | Complete procedure input as JSON; do not combine it with field flags. |
--client-token <uuid> | No | None | Stable UUID to reuse when retrying the exact same mutation. |
Input
This command presents the capability recording.complete. 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)$"},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"]},"sourceUrl":{"type":"string"},"interrupted":{"default":false,"type":"boolean"},"canvasId":{"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)$"},"organisationId":{"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)$"},"audioChunkCount":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"hasRecoverableBytes":{"default":false,"type":"boolean"}},"required":["recordingId","durationMs","viewport","sourceUrl"]}Output
This command writes JSON records to standard output. Returns a typed recording.complete 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":{"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)$"},"canvasId":{"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)$"},"canvasTitle":{"type":"string","minLength":1},"isNewCanvas":{"type":"boolean"},"storedChunkCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingChunkIndexes":{"maxItems":64,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}},"missingChunkCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"storedAudioChunkCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingAudioChunkIndexes":{"maxItems":64,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}},"missingAudioChunkCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"integrity":{"type":"string","enum":["whole","recovering","partial"]}},"required":["recordingId","canvasId","canvasTitle","isNewCanvas","storedChunkCount","missingChunkIndexes","missingChunkCount","storedAudioChunkCount","missingAudioChunkIndexes","missingAudioChunkCount","integrity"],"additionalProperties":false}Examples
enhance-dev recording complete --recording-id <string> --duration-ms <number> --source-url <string>Show example input
{
"recordingId": "00000000-0000-4000-8000-000000000010",
"durationMs": 0,
"viewport": {
"width": 1,
"height": 1
},
"sourceUrl": "x"
}Show example output
{
"recordingId": "00000000-0000-4000-8000-000000000010",
"canvasId": "00000000-0000-4000-8000-000000000010",
"canvasTitle": "x",
"isNewCanvas": false,
"storedChunkCount": 0,
"missingChunkIndexes": [],
"missingChunkCount": 0,
"storedAudioChunkCount": 0,
"missingAudioChunkIndexes": [],
"missingAudioChunkCount": 0,
"integrity": "whole"
}Exit behaviour
| Exit code | Meaning |
|---|---|
0 | The command succeeded. |
1 | The command failed for another reason (INTERNAL). A write may have an unknown outcome. |
2 | The command line was malformed. Nothing ran. |
3 | The API refused the input (BAD_REQUEST). |
4 | The credential is missing or expired (UNAUTHORIZED). |
5 | The API refused the request (FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED). |
6 | A 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.