mirror of
https://github.com/stablyai/orca.git
synced 2026-10-24 08:03:58 +00:00
184 lines
12 KiB
TypeScript
184 lines
12 KiB
TypeScript
export const ROOT_HELP_TEXT_SECONDARY = [
|
|
' uncheck Uncheck a checkbox by --element ref',
|
|
' focus Focus an element by --element ref',
|
|
' clear Clear an input by --element ref',
|
|
' drag Drag --from ref to --to ref',
|
|
' upload Upload --files to a file input by --element ref',
|
|
' dblclick Double-click element by --element ref',
|
|
' forward Navigate forward in browser history',
|
|
' scrollintoview Scroll --element into view',
|
|
' get Get element property (--what: text, html, value, url, title)',
|
|
' is Check element state (--what: visible, enabled, checked)',
|
|
' inserttext Insert text without key events',
|
|
' mouse move Move mouse to --x --y coordinates',
|
|
' mouse down Press mouse button',
|
|
' mouse up Release mouse button',
|
|
' mouse wheel Scroll wheel --dy [--dx]',
|
|
' find Find element by locator (--locator role|text|label --value <v>)',
|
|
' set device Emulate device (--name "iPhone 12")',
|
|
' set offline Toggle offline mode (--state on|off)',
|
|
' set headers Set HTTP headers (--headers \'{"key":"val"}\')',
|
|
' set credentials Set HTTP auth (--user <u> --pass <p>)',
|
|
' set media Set color scheme (--color-scheme dark|light)',
|
|
' clipboard read Read clipboard contents',
|
|
' clipboard write Write --text to clipboard',
|
|
' dialog accept Accept browser dialog (--text for prompt response)',
|
|
' dialog dismiss Dismiss browser dialog',
|
|
' storage local get Get localStorage value by --key',
|
|
' storage local set Set localStorage --key --value',
|
|
' storage local clear Clear localStorage',
|
|
' storage session get Get sessionStorage value by --key',
|
|
' storage session set Set sessionStorage --key --value',
|
|
' storage session clear Clear sessionStorage',
|
|
' download Download file via --selector to --path',
|
|
' highlight Highlight --selector on page',
|
|
' exec Run any agent-browser command (--command "...")',
|
|
'',
|
|
'Common Commands:',
|
|
' orca open [--json]',
|
|
' orca serve [--port <port>] [--pairing-address <host>] [--mobile-pairing] [--no-pairing] [--project-root <path>] [--recipe-json] [--json]',
|
|
' orca status [--json]',
|
|
' orca diagnostics memory [--json]',
|
|
' orca agent-context [--json]',
|
|
' orca account add [--agent claude|codex] [--json]',
|
|
' orca account list [--json]',
|
|
' orca host list [--json]',
|
|
' orca environment add --name <name> --pairing-code <code> [--json]',
|
|
' orca environment list [--json]',
|
|
' orca environment show --environment <selector> [--json]',
|
|
' orca environment rm --environment <selector> [--json]',
|
|
' orca worktree list [--repo <selector>] [--limit <n>] [--json]',
|
|
' orca worktree create --name <name> [--repo <selector>|--project <id> [--host <host-id>]|--project-host-setup <id>] [--agent <id>] [--prompt <text>] [--setup run|skip|inherit] [--base-branch <ref>] [--issue <number>] [--linear-issue <identifier-or-url>] [--comment <text>] [--parent-worktree <selector>] [--no-parent] [--run-hooks] [--activate] [--json]',
|
|
' orca worktree show --worktree <selector> [--json]',
|
|
' orca worktree current [--json]',
|
|
' orca worktree set --worktree <selector> [--display-name <name>] [--issue <number|null>] [--linear-issue <identifier-or-url|null>] [--comment <text>] [--workspace-status <id>] [--parent-worktree <selector>|--no-parent] [--json]',
|
|
' orca worktree rm --worktree <selector> [--force] [--run-hooks] [--json]',
|
|
' orca worktree ps [--limit <n>] [--json]',
|
|
' orca file open <path> [--worktree <selector>] [--json]',
|
|
' orca file diff <path> [--staged] [--worktree <selector>] [--json]',
|
|
' orca file open-changed [--mode edit|diff|both] [--worktree <selector>] [--json]',
|
|
' orca terminal list [--worktree <selector>] [--limit <n>] [--include-visual-layouts] [--json]',
|
|
' orca terminal show [--terminal <handle>] [--json]',
|
|
' orca terminal read [--terminal <handle>] [--cursor <n>] [--limit <n>] [--json]',
|
|
' orca terminal send [--terminal <handle>] [--text <text>] [--enter] [--interrupt] [--json]',
|
|
' orca terminal wait [--terminal <handle>] --for exit|tui-idle [--timeout-ms <ms>] [--json]',
|
|
' orca terminal stop --worktree <selector> [--json]',
|
|
' orca terminal create [--worktree <selector>] [--title <name>] [--command <text>] [--focus] [--json]',
|
|
' orca terminal split [--terminal <handle>] [--direction horizontal|vertical] [--json]',
|
|
' orca terminal switch [--terminal <handle>] [--json]',
|
|
' orca terminal close [--terminal <handle>] [--tab] [--json]',
|
|
' orca project list [--json]',
|
|
' orca project setups [--project <id>] [--host <host-id>] [--json]',
|
|
' orca project setup-existing-folder --project <id> --host <host-id> --path <path> [--kind git|folder] [--display-name <name>] [--json]',
|
|
' orca project setup-clone --project <id> --host <host-id> --url <clone-url> --destination <path> [--display-name <name>] [--json]',
|
|
' orca project setup-create --project <id> --host <host-id> [--setup-id <id>] [--path <path>] [--kind git|folder] [--display-name <name>] [--worktree-base-path <path>] [--git-username <name>] [--state ready|not-set-up|setting-up|error|unsupported] [--method imported-existing-folder|cloned|provisioned] [--json]',
|
|
' orca project setup-update --setup <setup-id> [--display-name <name>] [--path <path>] [--worktree-base-path <path>] [--git-username <name>] [--kind git|folder] [--state ready|not-set-up|setting-up|error|unsupported] [--method legacy-repo|imported-existing-folder|cloned|provisioned] [--json]',
|
|
' orca project setup-delete --setup <setup-id> [--json]',
|
|
' orca repo list [--json]',
|
|
' orca repo add --path <path> [--json]',
|
|
' orca repo show --repo <selector> [--json]',
|
|
' orca repo set-base-ref --repo <selector> --ref <ref> [--json]',
|
|
' orca repo search-refs --repo <selector> --query <text> [--limit <n>] [--json]',
|
|
'',
|
|
'Selectors:',
|
|
' --repo <selector> Registered repo selector such as id:<id>, name:<name>, or path:<path>',
|
|
' --worktree <selector> Worktree selector such as identity:<identity>, id:<repo-id>::<path>, name:<displayName>, branch:<branch>, issue:<number>, path:<path>, or active/current',
|
|
' --terminal <handle> Runtime-issued terminal handle returned by `orca terminal list --json`',
|
|
' --parent-worktree <selector> Parent worktree selector such as identity:<identity>, id:<repo-id>::<path>, branch:<branch>, issue:<number>, path:<path>, or active/current',
|
|
' --no-parent Force no parent lineage for unrelated worktree creation/update',
|
|
'',
|
|
'Terminal Send Options:',
|
|
' --text <text> Text to send to the terminal',
|
|
' --enter Append Enter after sending text',
|
|
' --interrupt Send as an interrupt-style input when supported',
|
|
'',
|
|
'Terminal List Options:',
|
|
' --include-visual-layouts Include tab and pane topology in JSON output',
|
|
'',
|
|
'Wait Options:',
|
|
' --for exit Wait until the target terminal exits',
|
|
' --timeout-ms <ms> Maximum wait time before timing out',
|
|
'',
|
|
'Output Options:',
|
|
' --json Emit machine-readable JSON instead of human text',
|
|
' --pairing-code <code> Connect to a remote Orca runtime using an orca://pair?... code',
|
|
' --environment <selector> Connect using a saved environment id or name',
|
|
' --help Show this help message',
|
|
'',
|
|
'Behavior:',
|
|
' Most commands require a running Orca runtime. If Orca is not open yet, run `orca open` first.',
|
|
' Remote runtime access can also be supplied with ORCA_PAIRING_CODE or ORCA_ENVIRONMENT.',
|
|
' Use selectors for discovery and handles for repeated live terminal operations.',
|
|
'',
|
|
'Agent Sessions And Worktrees:',
|
|
' `worktree create --agent` creates a new checkout with an agent.',
|
|
' To start a fresh agent in the current worktree, use:',
|
|
' orca terminal create --worktree active --command "codex"',
|
|
'',
|
|
'Browser Workflow:',
|
|
' 1. Create or navigate: orca tab create --url https://example.com',
|
|
' orca goto --url https://example.com',
|
|
' 2. Inspect the page: orca snapshot',
|
|
' (Returns an accessibility tree with element refs like e1, e2, e3)',
|
|
' For concurrent workflows, prefer: orca tab list --json',
|
|
' then reuse tabs[].browserPageId with --page <id> on later commands.',
|
|
' 3. Interact: orca click --element e2',
|
|
' orca fill --element e5 --value "search query"',
|
|
' orca keypress --key Enter',
|
|
' 4. Re-inspect: orca snapshot',
|
|
' (Element refs change after navigation — always re-snapshot before interacting)',
|
|
'',
|
|
'Browser Options:',
|
|
' --element <ref> Element ref from snapshot (e.g. @e3)',
|
|
' --url <url> URL to navigate to',
|
|
' --value <text> Value to fill or select',
|
|
' --input <text> Text to type at current focus (no element needed)',
|
|
' --expression <js> JavaScript expression to evaluate',
|
|
' --key <key> Key to press (Enter, Tab, Escape, Control+a, etc.)',
|
|
' --direction <dir> Scroll direction: up or down',
|
|
' --amount <pixels> Scroll distance in pixels (default: viewport height)',
|
|
' --index <n> Tab index (from `tab list`)',
|
|
' --page <id> Stable browser page id (preferred for concurrent workflows)',
|
|
' --profile <id> Browser profile id',
|
|
" --show-profile Include the tab's browser profile in text output",
|
|
" --no-ua-spoof Keep Electron's native user agent for a new profile",
|
|
' --format <png|jpeg> Screenshot image format',
|
|
' --from <ref> Drag source element ref',
|
|
' --to <ref> Drag target element ref',
|
|
' --files <path,...> Comma-separated file paths for upload',
|
|
' --timeout <ms> Wait timeout in milliseconds',
|
|
" --worktree <selector> Scope commands to a specific worktree's browser tabs",
|
|
'',
|
|
'Examples:',
|
|
' $ orca open',
|
|
' $ orca status --json',
|
|
' $ orca diagnostics memory --json',
|
|
' $ orca repo list',
|
|
' $ orca worktree create --name agent-task --agent codex --prompt "hi"',
|
|
' $ orca worktree create --repo name:orca --name cli-test-1 --issue 273',
|
|
' $ orca worktree create --repo name:orca --name linear-task --linear-issue https://linear.app/stably/issue/STA-335/test-issue',
|
|
' $ orca worktree create --name linear-task --linear-issue STA-335',
|
|
' $ orca worktree show --worktree branch:Jinwoo-H/cli',
|
|
' $ orca worktree current',
|
|
' $ orca worktree set --worktree active --comment "waiting on review"',
|
|
' $ orca worktree set --worktree active --linear-issue null',
|
|
' $ orca worktree ps --limit 10',
|
|
' $ orca file open-changed --mode diff',
|
|
' $ orca file open src/App.tsx',
|
|
' $ orca terminal create --worktree active --command "codex"',
|
|
' $ orca terminal list --worktree path:/Users/me/orca/workspaces/orca/cli-test-1 --json',
|
|
' $ orca terminal send --terminal term_123 --text "hi" --enter',
|
|
' $ orca terminal wait --terminal term_123 --for exit --timeout-ms 60000 --json',
|
|
' $ orca tab current --json',
|
|
' $ orca tab show --page page_123 --json',
|
|
' $ orca tab create --url https://example.com --profile work',
|
|
' $ orca tab profile clone --page page_123 --profile work --json',
|
|
' $ orca snapshot',
|
|
' $ orca click --element e3',
|
|
' $ orca fill --element e5 --value "hello"',
|
|
' $ orca goto --url https://example.com/login',
|
|
' $ orca keypress --key Enter',
|
|
' $ orca eval --expression "document.title"',
|
|
' $ orca tab list --json'
|
|
].join('\n')
|