export interface CommandFlag { readonly flag: string; readonly description: string; } export interface CommandHelp { readonly summary: string; readonly usage: string; readonly flags: readonly CommandFlag[]; } export declare const commandHelpTable: { readonly permissions: { readonly summary: "Check Screeny grants or request missing permissions."; readonly usage: "screeny permissions [--request]"; readonly flags: readonly [{ readonly flag: "--request"; readonly description: "Request the Screeny system permissions."; }]; }; readonly record: { readonly summary: "Run a TypeScript recording module and write a take."; readonly usage: "screeny record --out "; readonly flags: readonly [{ readonly flag: "--out "; readonly description: "Write the recorded take artifacts to this directory."; }]; }; readonly start: { readonly summary: "Open a live take against a specific app or window."; readonly usage: "screeny start --out (--app | --window-id ) [--capture display: | region::,,,]"; readonly flags: readonly [{ readonly flag: "--out "; readonly description: "Write the live take artifacts to this directory."; }, { readonly flag: "--app "; readonly description: "Bind the take to a running app by bundle identifier."; }, { readonly flag: "--window-id "; readonly description: "Bind the take to a specific window id."; }, { readonly flag: "--capture display:"; readonly description: "Capture a full display instead of the target window."; }, { readonly flag: "--capture region::,,,"; readonly description: "Capture a display-local region instead of the target window."; }]; }; readonly see: { readonly summary: "Catalog the bound window's elements as a snapshot for --on actions."; readonly usage: "screeny see [--app ]"; readonly flags: readonly [{ readonly flag: "--app "; readonly description: "Catalog a running app when no take is live."; }]; }; readonly query: { readonly summary: "Read a snapshot element's current value from the bound app."; readonly usage: "screeny query --on --snapshot "; readonly flags: readonly [{ readonly flag: "--on "; readonly description: "Target the element id from a snapshot."; }, { readonly flag: "--snapshot "; readonly description: "Use the snapshot that contains the target element."; }]; }; readonly mark: { readonly summary: "Name the next live interaction for cut anchors."; readonly usage: "screeny mark "; readonly flags: readonly []; }; readonly unmark: { readonly summary: "Discard the armed live-interaction mark."; readonly usage: "screeny unmark"; readonly flags: readonly []; }; readonly move: { readonly summary: "Move the real cursor to an element or coordinate."; readonly usage: "screeny move (--on --snapshot | --coords ,) [--profile human|linear] [--duration ] [--steps ]"; readonly flags: readonly [{ readonly flag: "--on "; readonly description: "Move to the element id from a snapshot."; }, { readonly flag: "--snapshot "; readonly description: "Use the snapshot that contains the target element."; }, { readonly flag: "--coords ,"; readonly description: "Move to screen coordinates in points."; }, { readonly flag: "--profile human|linear"; readonly description: "Choose the cursor movement profile."; }, { readonly flag: "--duration "; readonly description: "Set the cursor movement duration."; }, { readonly flag: "--steps "; readonly description: "Set the number of generated cursor samples."; }]; }; readonly click: { readonly summary: "Click an element or coordinate in the live take."; readonly usage: "screeny click (--on --snapshot | --coords ,)"; readonly flags: readonly [{ readonly flag: "--on "; readonly description: "Click the element id from a snapshot."; }, { readonly flag: "--snapshot "; readonly description: "Use the snapshot that contains the target element."; }, { readonly flag: "--coords ,"; readonly description: "Click screen coordinates in points."; }]; }; readonly type: { readonly summary: "Type text into the focused field or a snapshot element."; readonly usage: "screeny type [--on --snapshot ] [--wpm ]"; readonly flags: readonly [{ readonly flag: "--on "; readonly description: "Type into the element id from a snapshot."; }, { readonly flag: "--snapshot "; readonly description: "Use the snapshot that contains the target element."; }, { readonly flag: "--wpm "; readonly description: "Set the typing speed in words per minute."; }]; }; readonly press: { readonly summary: "Press a keyboard key, optionally with modifiers."; readonly usage: "screeny press [--mods cmd,shift,...]"; readonly flags: readonly [{ readonly flag: "--mods cmd,shift,..."; readonly description: "Hold comma-separated modifiers while pressing the key."; }]; }; readonly scroll: { readonly summary: "Scroll the focused target or a snapshot element."; readonly usage: "screeny scroll [--on --snapshot ] [--dx ] [--dy ]"; readonly flags: readonly [{ readonly flag: "--on "; readonly description: "Scroll the element id from a snapshot."; }, { readonly flag: "--snapshot "; readonly description: "Use the snapshot that contains the target element."; }, { readonly flag: "--dx "; readonly description: "Set the horizontal scroll delta."; }, { readonly flag: "--dy "; readonly description: "Set the vertical scroll delta."; }]; }; readonly drag: { readonly summary: "Drag between two elements or coordinates."; readonly usage: "screeny drag (--from --to --snapshot | --from-coords , --to-coords ,)"; readonly flags: readonly [{ readonly flag: "--from "; readonly description: "Start from the element id in a snapshot."; }, { readonly flag: "--to "; readonly description: "End on the element id in a snapshot."; }, { readonly flag: "--snapshot "; readonly description: "Use the snapshot that contains both target elements."; }, { readonly flag: "--from-coords ,"; readonly description: "Start from screen coordinates in points."; }, { readonly flag: "--to-coords ,"; readonly description: "End on screen coordinates in points."; }]; }; readonly displays: { readonly summary: "List capture display UUIDs and geometry."; readonly usage: "screeny displays"; readonly flags: readonly []; }; readonly status: { readonly summary: "Show whether a live take is running."; readonly usage: "screeny status"; readonly flags: readonly []; }; readonly stop: { readonly summary: "Finalize the live take and write its artifacts."; readonly usage: "screeny stop"; readonly flags: readonly []; }; readonly abort: { readonly summary: "End the live take early, preserving captured evidence when present."; readonly usage: "screeny abort"; readonly flags: readonly []; }; readonly moments: { readonly summary: "List moment ids from a moments artifact."; readonly usage: "screeny moments "; readonly flags: readonly []; }; readonly "derive-moments": { readonly summary: "Derive moments from a completed take's artifacts."; readonly usage: "screeny derive-moments --execution --events --cursor --recording --frame-timeline --out "; readonly flags: readonly [{ readonly flag: "--execution "; readonly description: "Read the execution artifact."; }, { readonly flag: "--events "; readonly description: "Read the event log artifact."; }, { readonly flag: "--cursor "; readonly description: "Read the cursor track artifact."; }, { readonly flag: "--recording "; readonly description: "Read the recording artifact."; }, { readonly flag: "--frame-timeline "; readonly description: "Read the frame timeline artifact."; }, { readonly flag: "--out "; readonly description: "Write the derived moments artifact."; }]; }; readonly "compile-cut": { readonly summary: "Compile a .screenycut file into a cut plan."; readonly usage: "screeny compile-cut [--out ]"; readonly flags: readonly [{ readonly flag: "--out "; readonly description: "Write the compiled cut instead of printing it."; }]; }; readonly resolve: { readonly summary: "Resolve a compiled cut against immutable take artifacts."; readonly usage: "screeny resolve --cut --take = ... --out [--export]"; readonly flags: readonly [{ readonly flag: "--cut "; readonly description: "Read the compiled cut artifact."; }, { readonly flag: "--take ="; readonly description: "Bind a take id to its artifact directory."; }, { readonly flag: "--out "; readonly description: "Write the resolved render plan."; }, { readonly flag: "--export"; readonly description: "Refuse unresolved export gaps instead of previewing them."; }]; }; readonly trace: { readonly summary: "Inspect camera movement for a single resolved take."; readonly usage: "screeny trace --resolved --cursor --recording --frame-timeline [--out ]"; readonly flags: readonly [{ readonly flag: "--resolved "; readonly description: "Read the resolved render plan."; }, { readonly flag: "--cursor "; readonly description: "Read the cursor track artifact."; }, { readonly flag: "--recording "; readonly description: "Read the recording artifact."; }, { readonly flag: "--frame-timeline "; readonly description: "Read the frame timeline artifact."; }, { readonly flag: "--out "; readonly description: "Write the trace artifact instead of only printing it."; }]; }; readonly render: { readonly summary: "Render a resolved cut to a movie file."; readonly usage: "screeny render --resolved --take = ... --out [--preview]"; readonly flags: readonly [{ readonly flag: "--resolved "; readonly description: "Read the resolved render plan."; }, { readonly flag: "--take ="; readonly description: "Bind a take id to its artifact directory."; }, { readonly flag: "--out "; readonly description: "Write the rendered movie: .mp4 for the H.264 export, .mov for the ProRes export."; }, { readonly flag: "--preview"; readonly description: "Allow preview rendering through unresolved gaps."; }]; }; readonly activate: { readonly summary: "Activate a Screeny Pro license key."; readonly usage: "screeny activate --key "; readonly flags: readonly [{ readonly flag: "--key "; readonly description: "Use this license key for activation."; }]; }; readonly license: { readonly summary: "Show the current Screeny license tier."; readonly usage: "screeny license"; readonly flags: readonly []; }; readonly version: { readonly summary: "Print the Screeny command service version."; readonly usage: "screeny version"; readonly flags: readonly []; }; readonly "selftest-render": { readonly summary: "Run the renderer self-test."; readonly usage: "screeny selftest-render [--out ]"; readonly flags: readonly [{ readonly flag: "--out "; readonly description: "Write self-test artifacts to this directory."; }]; }; readonly "selftest-contracts": { readonly summary: "Write command contract fixtures."; readonly usage: "screeny selftest-contracts [--out ]"; readonly flags: readonly [{ readonly flag: "--out "; readonly description: "Write contract fixtures to this directory."; }]; }; }; export declare const documentedCommands: readonly ["permissions", "record", "start", "see", "query", "mark", "unmark", "move", "click", "type", "press", "scroll", "drag", "displays", "status", "stop", "abort", "moments", "derive-moments", "compile-cut", "resolve", "trace", "render", "activate", "license", "version"]; export type CommandName = keyof typeof commandHelpTable; export declare const commandNames: string[]; export declare function isKnownCommand(name: string): name is CommandName; export declare function topLevelHelp(): string; export declare function commandHelp(name: string): string | undefined; export declare function usageLine(name: string): string | undefined; export declare function argumentError(command: string, argv: readonly string[]): string | undefined; //# sourceMappingURL=help.d.ts.map