orca-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Orca CLI

Orca CLI

This file is a discovery stub, not the usage guide. The full, version-matched Orca CLI reference is served by the
orca
binary itself — kept out of this file on purpose so it can never drift from the binary that will actually run your commands.
Engage Orca whenever its running editor/runtime is the source of truth: Orca-managed worktrees, folder contexts, terminals, repos, automations, worktree comments, and the browser embedded inside the Orca app. Triggers include "$orca-cli", "Orca worktree", "child worktree", "spawn codex/claude in a worktree", "read/wait/send Orca terminal", "full handoff" / "handover" / "give this to another agent", and "control the browser inside Orca". Use plain shell tools when Orca state does not matter.
本文档是一个发现存根,并非使用指南。完整的、版本匹配的Orca CLI 参考文档由
orca
二进制文件本身提供——特意不写入本文档,以确保 其永远不会与实际执行命令的二进制文件出现版本偏差。
当Orca运行的编辑器/运行时是事实数据源时,使用Orca:包括由Orca管理的 工作树、文件夹上下文、终端、代码仓库、自动化流程、工作树评论以及Orca应用内嵌入的浏览器。触发场景包括提及“$orca-cli”、“Orca worktree”、 “child worktree”、“spawn codex/claude in a worktree”、“read/wait/send Orca terminal”、 “full handoff”/“handover”/“give this to another agent”以及“control the browser inside Orca”。当Orca状态无关紧要时,使用普通Shell工具。

Resolve the CLI for this session

解析当前会话的CLI

Choose the executable once and reuse it for every later command:
  • If the
    ORCA_CLI_COMMAND
    environment variable is set, use its value. Orca exports this for managed WSL sessions.
  • Otherwise, in a dev checkout whose session exposes
    ORCA_DEV_REPO_ROOT
    , use
    orca-dev
    .
  • Otherwise, on Linux outside an Orca-managed terminal, use
    orca-ide
    . Never run bare
    orca
    there — outside Orca's terminals it normally resolves to the GNOME Orca screen reader (
    /usr/bin/orca
    ) and starts speech on the user's machine.
  • Otherwise, use
    orca
    .
Below,
ORCA
is a placeholder for the executable you resolved. Substitute it before running anything; do not create a shell variable or run
ORCA
literally. This works the same way in POSIX shells, PowerShell, and cmd.exe.
If the selected executable cannot run, report its exact error and stop. Do not fall through to another executable, which could silently target a different Orca build.
选择一次可执行文件,并在后续所有命令中重复使用:
  • 如果已设置
    ORCA_CLI_COMMAND
    环境变量,则使用其值。Orca会为受管理的WSL会话导出该变量。
  • 否则,在暴露
    ORCA_DEV_REPO_ROOT
    的开发检出会话中,使用
    orca-dev
  • 否则,在Orca管理的终端之外的Linux环境中,使用
    orca-ide
    。切勿在此处运行原生
    orca
    ——在Orca终端之外,它通常会解析为GNOME Orca屏幕阅读器(
    /usr/bin/orca
    )并启动用户机器的语音功能。
  • 否则,使用
    orca
下文的
ORCA
是你所解析出的可执行文件的占位符。在运行任何命令前替换它;不要创建Shell变量或直接运行
ORCA
。此方式在POSIX Shells、PowerShell和cmd.exe中均适用。
如果所选可执行文件无法运行,报告其确切错误并停止。不要切换到其他可执行文件,否则可能会静默地指向不同版本的Orca构建。

Load the full guide before running Orca commands

运行Orca命令前加载完整指南

text
ORCA skills get orca-cli
That prints the complete, version-matched guide for the exact binary that will handle your next commands — worktrees, handoffs, terminals, automations, and the built-in browser. Read it first, then run the specific command you need.
Don't guess subcommands or flags from memory or from a cached copy of this stub. They change between Orca releases, and this file deliberately no longer lists them. Confirm the app is up with
ORCA status --json
(start it with
ORCA open --json
if needed), and prefer
--json
for agent-driven calls.
text
ORCA skills get orca-cli
该命令会打印出与将处理你后续命令的二进制文件完全匹配的完整指南——涵盖工作树、交接、终端、自动化流程和内置浏览器。先阅读指南,再运行所需的特定命令。
不要凭记忆或缓存的存根副本猜测子命令或参数。它们会在Orca版本迭代中发生变化,且本文档特意不再列出这些内容。使用
ORCA status --json
确认应用已启动(若需启动则使用
ORCA open --json
),且在由Agent驱动的调用中优先使用
--json
参数。

If an older Orca does not recognize
skills get

如果旧版本Orca无法识别
skills get
命令

Use this fallback only when the selected binary explicitly reports that
skills get
is an unknown command. Another failure is not proof of an older binary; report it rather than guessing or changing executables. For a confirmed pre-guide binary, use only this bounded, read-only bootstrap to orient. Do not dead-end and do not invent commands:
text
ORCA status --json
ORCA worktree ps --json
ORCA terminal list --json
Then tell the user that updating Orca restores the full, version-matched guide via
ORCA skills get orca-cli
. Beyond these commands, ask the user rather than guessing a command surface this older binary may not support.
仅当所选二进制文件明确报告
skills get
是未知命令时,才使用此回退方案。其他故障不能证明是旧版本二进制文件;应报告错误而非猜测或切换可执行文件。对于确认的无指南版本二进制文件,仅使用以下有限的只读引导命令来定位。不要陷入死胡同或自行发明命令:
text
ORCA status --json
ORCA worktree ps --json
ORCA terminal list --json
然后告知用户,更新Orca后可通过
ORCA skills get orca-cli
恢复完整的版本匹配指南。除这些命令外,若旧版本二进制文件可能不支持其他命令,请询问用户而非自行猜测。