mirror of
https://github.com/stablyai/orca.git
synced 2026-09-26 00:02:34 +00:00
Publish the standalone docs site under docs/site and deploy it on stable desktop releases.
44 lines
2.7 KiB
Plaintext
44 lines
2.7 KiB
Plaintext
---
|
|
title: Codex in Orca
|
|
---
|
|
|
|
Codex is OpenAI's agentic CLI. Orca's Codex integration is one of the deepest in the app — usage, hot-swap, and restart all preserve account identity.
|
|
|
|
## Setup
|
|
|
|
1. Install Codex per OpenAI's docs.
|
|
1. Log in from any terminal.
|
|
1. Orca reads `~/.codex` for accounts and credentials.
|
|
|
|
## Launching
|
|
|
|
Pick **Codex** from the agent combobox. Orca launches `codex` with the worktree as `cwd` and routes auth through the currently selected account.
|
|
|
|
## Account hot-swap
|
|
|
|
Many Codex users run multiple accounts to stretch rate limits. Orca's account switcher swaps the active account without re-login or config edits. See [Hot-swap Codex accounts](/docs/agents/codex-hot-swap).
|
|
|
|
## System default vs extra accounts
|
|
|
|
**System default** uses your real `~/.codex` login (the same home a bare `codex` outside Orca would use). Extra accounts Orca manages get their own home under Orca's account data so credentials and rollouts stay isolated. New Codex launches follow the active account; already-running sessions keep the home they started with until you restart them.
|
|
|
|
## Nested Task subagents
|
|
|
|
When Codex spawns Task subagents, Orca can show them as child rows under the parent agent on the worktree agent list and [Agent Dashboard](/docs/model/agents-sessions#agent-dashboard). Expand the chevron to see each child; click a child to focus the parent terminal (subagents do not own a separate pane).
|
|
|
|
## Continue in a new session
|
|
|
|
From an agent terminal's header or context menu, choose **Continue in New Session…**. Orca starts a fresh agent session (same or different CLI) and injects a bounded handoff prompt from the prior transcript or captured context. The original session is left alone — this is not `codex resume`.
|
|
|
|
## Restart chip
|
|
|
|
When Codex exits, the restart chip relaunches the agent with the same account. If you swapped accounts mid-session and want to restart with the new one, use the account switcher first, then restart.
|
|
|
|
## Usage & rate limits
|
|
|
|
Orca reads local Codex usage state for the active account and surfaces it in the status bar. See [Usage & rate-limit tracking](/docs/agents/usage-tracking).
|
|
|
|
## Codex on Windows (WSL)
|
|
|
|
On Windows, Orca can run Codex either from your host install or from a WSL distro. Add a WSL-hosted Codex account from the account switcher — Orca creates an isolated account home inside the distro (under `~/.local/share/orca/codex-accounts/<id>/home`), maps it back to the host as a `\\wsl.localhost\<distro>\...` path for auth reads, and routes launches, hot-swap, and rate-limit fetches through the selected distro. If Codex isn't installed in the target distro, the **Add account** dialog fails with an actionable message telling you which distro is missing the binary.
|