enhancedocs
For agentsOpen Enhance ↗
CLI commands / enhance-dev screen delete

Enhance documentation

enhance-dev screen delete

Delete an unattached captured page owned by this person.

↓ Markdown

enhance-dev screen delete

enhance-dev screen delete [options]

Arguments

This command takes no positional arguments.

Options

OptionRequiredDefaultMeaning
--screen-id <string>YesNoneScreen id returned by enhance screen create or fixture screen.
--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 screen.delete. It has delete effect and single idempotency.

Show complete input JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"screenId":{"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)$"}},"required":["screenId"]}

Output

This command writes JSON records to standard output. Returns a typed screen.delete 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":{"screenId":{"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)$"},"deletedThreadCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["screenId","deletedThreadCount"],"additionalProperties":false}

Examples

enhance-dev screen delete --screen-id <string>
Show example input
{
 "screenId": "00000000-0000-4000-8000-000000000010"
}
Show example output
{
 "screenId": "00000000-0000-4000-8000-000000000010",
 "deletedThreadCount": 0
}

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.