Files
orca/src/cli/command-scoped-flag-help.ts
T
NeilandEugenio Valeiras 6d04aea3f1 feat(cli): resolve Jira keys in workspace references (#28619)
Recognize Jira issue references in workspace creation while retaining site-qualified identity and existing provider parsing.

Co-authored-by: Eugenio Valeiras <eugenio.valeiras@gmail.com>
2026-10-14 03:21:31 -07:00

81 lines
4.0 KiB
TypeScript

// Why: the shared --focus line describes terminal create's terminal session.
const FILE_OPEN_FOCUS_HELP =
"--focus Bring the user to the file (switches Orca's window to its worktree)"
/** Per-command flag help, kept out of the shared help chain it would crowd. */
const COMMAND_SCOPED_FLAG_HELP: Record<string, Record<string, string>> = {
'reference add': {
url: '--url <url-or-jira-key> Full review/issue URL or Jira key; use positionals or repeated --url',
'reference-site': '--reference-site <id> Jira site for bare keys; see orca jira connection'
},
'reference remove': {
url: '--url <url> Full review or issue URL; pass all URLs positionally or all as repeated --url',
key: '--key <key> Opaque key from reference list; repeat for several'
},
'reference find': {
query: '--query <url-or-key> Full URL or native issue key such as STA-1234',
repo: '--repo <selector> Filter by workspace repository membership',
'include-archived': '--include-archived Include archived workspaces',
limit: '--limit <n> Maximum matching workspaces (default 50)'
},
'worktree create': {
reference:
'--reference <url-or-jira-key> Attach an issue/review URL or Jira key; repeat for several',
'reference-site': '--reference-site <id> Jira site for bare keys; see orca jira connection',
pr: '--pr <number> Linked GitHub pull request number',
'gitlab-issue': '--gitlab-issue <number|url> Linked GitLab issue in the source project',
'gitlab-mr': '--gitlab-mr <number|url> Linked GitLab merge request in the source project'
},
'skills get': {
full: '--full Print the full guide with bundled references',
reference: '--reference <name> Print one bundled reference by name',
references: '--references List the bundled reference names for a topic'
},
'environment update': {
force: '--force Restart over running terminals instead of deferring the update'
},
'environment recover': {
'accept-changed-state':
'--accept-changed-state Restore the prelaunch snapshot over state a rejected build changed',
yes: '--yes Confirm discarding what the rejected build changed'
},
'environment stop': {
yes: '--yes Confirm stopping the server and unlinking it from this machine'
},
'file open': {
line: '--line <n> Cursor line (1-based)',
column: '--column <n> Cursor column (1-based; requires --line)',
focus: FILE_OPEN_FOCUS_HELP
},
'file diff': {
focus: FILE_OPEN_FOCUS_HELP
},
'file open-changed': {
focus: FILE_OPEN_FOCUS_HELP
},
'skills install': {
agent: '--agent <names> Comma-separated install targets; default is detected agents'
},
'worktree set': {
unread: '--unread Mark the workspace unread in the sidebar',
read: '--read Mark the workspace read, clearing the unread dot'
},
search: {
query: '--query <text> Search text; also accepted as the positional argument',
scope: '--scope <corpus> conversation (user and assistant turns) or all (default)',
fresh: '--fresh Wait up to 5s for the host to reconcile its index first',
limit: '--limit <n> Hits per page (default 20, maximum 100)',
cursor: '--cursor <cursor> Opaque cursor printed by the previous page of this search',
agent: '--agent <id> Restrict to one agent; repeat for several',
path: '--path <path> Restrict to an execution-host path; repeat for several',
since: '--since <iso> Only sessions updated at or after this ISO 8601 timestamp',
sort: '--sort <order> relevance (default) or newest',
debug: '--debug Include the planner route the host used',
'index-status': '--index-status Report the index instead of searching'
}
}
export function formatCommandScopedFlagHelp(command: string, flag: string): string | undefined {
return COMMAND_SCOPED_FLAG_HELP[command]?.[flag]
}