diff --git a/CHANGELOG.md b/CHANGELOG.md index 23f6318a8..5d7882801 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,10 @@ - Dependencies: update Google GenAI, MCP SDK, OpenAI, Chalk, Shiki, TokenTally, Puppeteer, Chrome DevTools protocol, Oxc tooling, and related packages. +### Docs + +- Rewrite the README around a verified install and quickstart, with detailed workflows linked to the docs site. + ### Fixed - Browser: preserve authenticated model-picker errors instead of appending a misleading cookie/login hint after login has already been verified. diff --git a/README-header.png b/README-header.png index ed92fbf51..4459907d4 100644 Binary files a/README-header.png and b/README-header.png differ diff --git a/README.md b/README.md index bfb9e0e88..768874586 100644 --- a/README.md +++ b/README.md @@ -1,403 +1,136 @@ -# oracle 🧿 — Whispering your tokens to the silicon sage +# oracle 🧿 — Bring a second brain, not a second briefing

Oracle CLI header banner

- npm version - CI Status - Platforms - MIT License + CI status + npm version + Node.js version + License + Homebrew tap

-Oracle bundles your prompt and files so another AI can answer with real context. It speaks GPT-5.5 Pro (default), GPT-5.5, GPT-5.4 Pro, GPT-5.4, GPT-5.1 Pro, GPT-5.1 Codex (API-only), GPT-5.1, GPT-5.2, Gemini 3.1 Pro, Gemini 3.5 Flash, Gemini 3.1 Flash-Lite, Claude Sonnet 4.6, Claude Opus 4.1, and more—and it can ask one or multiple models in a single run. Browser automation is available; use `--browser-model-strategy current` to keep the active ChatGPT model (or `ignore` to skip the picker). API remains the most reliable path, and `--copy` is an easy manual fallback. +Oracle is a CLI and MCP server that bundles a prompt with the files you select, sends that context to an AI model through an API or a signed-in browser, and stores the result as a session. It is for developers and coding agents that need a second-model review grounded in the actual project. -## Setting up (macOS Browser Mode) +Full documentation is at [askoracle.sh](https://askoracle.sh). -Browser mode lets you use GPT-5.5 Pro without any API keys — it automates your Chrome browser directly. +## Install -### First-time login - -Run this once to create Oracle's private automation profile and log into ChatGPT. This profile is separate from your normal Chrome profile. The browser will stay open so you can complete the login: - -```bash -oracle --engine browser --browser-manual-login \ - --browser-keep-browser --browser-input-timeout 120000 \ - -p "HI" -``` - -### Subsequent runs - -Once logged in, the automation profile is saved. Use this for all future runs: - -```bash -oracle --engine browser --browser-manual-login \ - --browser-auto-reattach-delay 5s \ - --browser-auto-reattach-interval 3s \ - --browser-auto-reattach-timeout 60s \ - -p "your prompt" -``` - -> **Why these flags?** -> -> - `--browser-manual-login` — Skips macOS Keychain cookie access (avoids repeated permission popups) -> - `--browser-auto-reattach-*` — Reconnects when ChatGPT redirects mid-page-load (fixes "Inspected target navigated or closed" error) -> - `--browser-keep-browser` — Keeps browser open for first-time login (not needed after) -> - `--browser-input-timeout 120000` — Gives you 2 minutes to log in on first run - -## Quick start - -Install globally: `npm install -g @steipete/oracle` -Homebrew: `brew install steipete/tap/oracle` - -Requires Node 24+. Or use `npx -y @steipete/oracle …` (or pnpx). +With Homebrew on macOS or Linux: ```bash -# Copy the bundle and paste into ChatGPT -npx -y @steipete/oracle --render --copy -p "Review the TS data layer for schema drift" --file "src/**/*.ts,*/*.test.ts" - -# Minimal API run (expects OPENAI_API_KEY in your env) -npx -y @steipete/oracle -p "Write a concise architecture note for the storage adapters" --file src/storage/README.md - -# Multi-model API run -npx -y @steipete/oracle -p "Cross-check the data layer assumptions" --models gpt-5.1-pro,gemini-3-pro --file "src/**/*.ts" - -# Follow up from an existing OpenAI/Azure session id -npx -y @steipete/oracle --engine api --model gpt-5.2-pro --followup release-readiness-audit --followup-model gpt-5.2-pro -p "Re-evaluate with this new context" --file "src/**/*.ts" - -# Follow up directly from an OpenAI Responses API id -npx -y @steipete/oracle --engine api --model gpt-5.2-pro --followup resp_abc1234567890 -p "Continue from this response" --file docs/notes.md - -# Preview without spending tokens -npx -y @steipete/oracle --dry-run summary -p "Check release notes" --file docs/release-notes.md - -# Check provider routing/readiness before an API panel -npx -y @steipete/oracle doctor --providers --models gpt-5.5-pro,gemini-3-pro,claude-4.6-sonnet - -# Multi-model advisory panel with recoverable partial success -npx -y @steipete/oracle --models gpt-5.5-pro,gemini-3-pro,claude-4.6-sonnet \ - --allow-partial --write-output /tmp/panel.md \ - -p "Review the naming options" --file docs/naming.md - -# Trace startup and time-to-first-output -npx -y @steipete/oracle --perf-trace --perf-trace-path /tmp/oracle-perf.json \ - --dry-run summary -p "Quick smoke" - -# Browser run (no API key, will open ChatGPT) -npx -y @steipete/oracle --engine browser -p "Walk through the UI smoke test" --file "src/**/*.ts" - -# Add explicit shared context to a ChatGPT Project without deleting anything -npx -y @steipete/oracle project-sources add \ - --chatgpt-url "https://chatgpt.com/g/g-p-example/project" \ - --browser-manual-login \ - --file docs/architecture.md \ - --dry-run - -# Browser multi-turn consult in one ChatGPT conversation -npx -y @steipete/oracle --engine browser --model gpt-5.5-pro \ - -p "Review this migration plan" --file docs/migration.md \ - --browser-follow-up "Challenge your previous recommendation" \ - --browser-follow-up "Give the final decision" - -# Gemini browser mode (no API key; uses Chrome cookies from gemini.google.com) -npx -y @steipete/oracle --engine browser --model gemini-3.1-pro --prompt "a cute robot holding a banana" --generate-image out.jpg --aspect 1:1 - -# Sessions (list and replay) -npx -y @steipete/oracle status --hours 72 -npx -y @steipete/oracle session --render -npx -y @steipete/oracle restart - -# TUI (interactive, only for humans) -npx -y @steipete/oracle tui +brew install steipete/tap/oracle ``` -Engine auto-picks API when `OPENAI_API_KEY` is set, otherwise browser; browser is stable on macOS and works on Linux and Windows. On Linux pass `--browser-chrome-path/--browser-cookie-path` if detection fails; on Windows prefer `--browser-manual-login` or inline cookies if decryption is blocked. - -## Integration - -**CLI** - -- API mode expects API keys in your environment: `OPENAI_API_KEY` (GPT-5.x), `GEMINI_API_KEY` (Gemini 3.1 Pro / 3.5 Flash / 3.1 Flash-Lite), `ANTHROPIC_API_KEY` (Claude Sonnet 4.6 / Opus 4.1). -- Gemini browser mode uses Chrome cookies instead of an API key—just be logged into `gemini.google.com` in Chrome (no Python/venv required). -- Gemini browser mode accepts explicit `gemini-3.1-flash-lite`, `gemini-3.5-flash`, and `gemini-3.1-pro` IDs. Legacy `gemini-3-pro` browser runs target current Gemini 3.1 Pro. If your account can’t access the requested model, Oracle falls back to 3.1 Flash-Lite and logs the fallback in verbose mode. -- Prefer API mode or `--copy` + manual paste; browser automation is experimental. -- Browser support: stable on macOS; works on Linux (add `--browser-chrome-path/--browser-cookie-path` when needed) and Windows (manual-login or inline cookies recommended when app-bound cookies block decryption). -- Remote browser service: `oracle serve` on a signed-in host; clients use `--remote-host/--remote-token`. -- Browser artifacts: browser sessions save `transcript.md` and generated artifacts under `~/.oracle/sessions//artifacts/`. Deep Research saves `deep-research-report.md` when the report surface is captured; ChatGPT-generated images and downloadable files are saved with the active browser session when supported file URLs are present. -- MCP image agents: use the `chatgpt_image` tool for the easiest path, or pass `generateImage` to `consult` with `engine: "browser"`; saved paths come back in `structuredContent.images`. -- Browser archiving: by default, successful non-project, non-Deep-Research, non-multi-turn ChatGPT one-shots are archived after local artifacts are saved. Use `--browser-archive never` to disable or `--browser-archive always` to force archiving after a successful browser run. Archived chats remain manageable in ChatGPT. -- Conversation mode guidance: use one-shot browser runs for narrow bug reports or quick file-set reviews; use explicit browser follow-ups for ambiguous architecture/product tradeoffs where a challenge pass and final decision are valuable; use Deep Research for broad public-web questions that need citations. Oracle never invents follow-ups automatically. -- Project Sources: `oracle project-sources list|add --chatgpt-url ` manages the Project Sources tab in ChatGPT browser mode. v1 is append-only (`list`, `add`, `--dry-run`) so agents can share explicit project context without deleting or replacing user sources. -- Fast failure: root runs without a prompt exit nonzero after printing help; `--dry-run` conflicts with `--render` / `--render-markdown`; foreground API runs exit 130 on Ctrl-C while browser cleanup and session recovery still run. -- Performance traces: `--perf-trace` / `ORACLE_PERF_TRACE=1` writes JSON timing marks for startup, root command, first output, and exit. `--perf-trace-path` or `--perf-trace=/tmp/oracle.json` selects the path; detached API children write a session-suffixed sidecar trace. -- AGENTS.md/CLAUDE.md: - ``` - - Oracle bundles a prompt plus the right files so another AI (GPT 5 Pro + more) can answer. Use when stuck/bugs/reviewing. - - Run `npx -y @steipete/oracle --help` once per session before first use. - ``` -- Tip: set `browser.chatgptUrl` in config (or `--chatgpt-url`) to a dedicated ChatGPT project folder so browser runs don’t clutter your main history. - -**Codex skill** - -- Copy the bundled skill from this repo to your Codex skills folder: - - `mkdir -p ~/.codex/skills` - - `cp -R skills/oracle ~/.codex/skills/oracle` -- Then reference it in your `AGENTS.md`/`CLAUDE.md` so Codex loads it. - -**MCP** - -- Run the stdio server via `oracle-mcp`. -- Configure clients via [steipete/mcporter](https://github.com/steipete/mcporter) or `.mcp.json`; see [docs/mcp.md](docs/mcp.md) for connection examples. -- Claude Code on the same Mac as a signed-in ChatGPT browser can generate a local config directly: +Or install the npm package globally: ```bash -oracle bridge claude-config --local-browser > .mcp.json +npm install -g @steipete/oracle ``` -- In MCP `consult`, use `preset: "chatgpt-pro-heavy"` for ChatGPT browser mode with `gpt-5.5-pro` and Pro Extended thinking. Add `dryRun: true` to inspect the resolved run without creating a session or touching Chrome. +Oracle requires Node.js 24 or newer. To try it without installing: ```bash -npx -y @steipete/oracle oracle-mcp -``` - -- Cursor setup (MCP): drop a `.cursor/mcp.json` like below, then pick “oracle” in Cursor’s MCP sources. See https://cursor.com/docs/context/mcp for UI steps. - [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=oracle&config=eyJjb21tYW5kIjoibnB4IC15IEBzdGVpcGV0ZS9vcmFjbGUgb3JhY2xlLW1jcCJ9) - -```json -{ - "oracle": { - "command": "oracle-mcp", - "args": [] - } -} +npx -y @steipete/oracle --help ``` -## Highlights - -- Bundle once, reuse anywhere (API or experimental browser). -- Multi-model API runs with aggregated cost/usage, including OpenRouter IDs alongside first-party models. -- Claude Code / MCP browser consults can use the `chatgpt-pro-heavy` preset for a compact ChatGPT Pro second-opinion workflow. -- Render/copy bundles for manual paste into ChatGPT when automation is blocked. -- GPT‑5 Pro API runs detach by default; reattach via `oracle session ` / `oracle status` or block with `--wait`. -- Saved ChatGPT browser conversations and OpenAI/Azure API runs can continue from `--followup `; for multi-model API parents, add `--followup-model `. -- Azure endpoints supported via `--azure-endpoint/--azure-deployment/--azure-api-version` or `AZURE_OPENAI_*` envs; use `--provider openai` / `--no-azure` to force first-party OpenAI when Azure env vars are present. -- Redacted provider checks via `oracle doctor --providers`, `--route`, and `--preflight` before spending API time. -- File safety: globs/excludes, size guards, `--files-report`. -- Sessions you can replay (`oracle status`, `oracle session --render`). -- Session logs and bundles live in `~/.oracle/sessions` (override with `ORACLE_HOME_DIR`). +See the [installation guide](docs/install.md) for pnpm, updates, API keys, and storage paths. -## API provider checks +## Quick start -Use these before expensive API or multi-model runs: +Build a review bundle locally before connecting any model: ```bash -oracle doctor --providers --models gpt-5.4,claude-4.6-sonnet,gemini-3-pro -oracle --preflight --models gpt-5.4,gemini-3-pro -oracle --provider openai --route --model gpt-5.4 +oracle --render \ + -p "Review the package metadata for release risks" \ + --file package.json ``` -`doctor` and `--preflight` print redacted readiness only: provider route, base host, key source, Azure state, and local configuration errors. `--route` shows the selected route and exits before creating a session. If Azure env/config is present but you want first-party OpenAI, add `--provider openai` or `--no-azure`. +This prints the exact prompt and numbered file contents Oracle would send. It does not need credentials and does not contact a model. -For advisory panels where one good answer is useful, combine partial success with explicit output files: +When an engine is configured, remove `--render` to request an answer: ```bash oracle \ - --models gpt-5.4,claude-4.6-sonnet,gemini-3-pro \ - --allow-partial \ - --write-output /tmp/oracle-panel.md \ - -p "Compare these naming options" + -p "Audit the model runner for race conditions" \ + --file "src/oracle/**/*.ts" \ + --file "!**/*.test.ts" ``` -Successful models write per-model files such as `/tmp/oracle-panel.gpt-5.4.md`; Oracle also writes `/tmp/oracle-panel.oracle.json` with successes, failures, output paths, and provider failure categories. +Oracle chooses API mode when an OpenAI key is available and browser mode otherwise. Use `--engine api` or `--engine browser` to make the choice explicit. The [quickstart](docs/quickstart.md) covers the first API and browser runs. -## Follow-up and lineage - -Use `--followup` to continue a saved ChatGPT browser conversation or an existing OpenAI/Azure Responses API run with additional context/files: - -```bash -oracle \ - --followup \ - --slug "my-browser-followup" \ - -p "Follow-up: review this additional file in the same conversation." \ - --file "server/src/strategy/plan.ts" -``` +## Choose an engine -Browser followup reopens the exact saved conversation and inherits its browser profile, configuration, and model. Resume fails closed before submission if Oracle cannot verify the saved thread and prior turns. +| Path | Use it when | Setup | +| ------- | --------------------------------------------------------------------------- | ---------------------------------------------------- | +| API | You want provider APIs, reliable automation, or multiple models in one run. | Set the key for the provider you use. | +| Browser | You want Oracle to use a signed-in ChatGPT or Gemini browser session. | Install Chrome and complete the one-time login flow. | +| Render | You want to inspect, copy, or paste the bundle yourself. | No account or key is required. | -```bash -oracle \ - --engine api \ - --model gpt-5.2-pro \ - --followup \ - --followup-model gpt-5.2-pro \ - --slug "my-followup-run" \ - --wait \ - -p "Follow-up: re-evaluate the previous recommendation with the attached files." \ - --file "server/src/strategy/plan.ts" \ - --file "server/src/strategy/executor.ts" -``` +API mode supports OpenAI, Azure OpenAI, Anthropic, Gemini, xAI, OpenRouter, and compatible endpoints. Browser mode uses Chrome automation for ChatGPT and a cookie-based Gemini client. See [browser mode](docs/browser-mode.md) and [provider endpoints](docs/openai-endpoints.md) for setup and limits. -When the parent session used `--models`, `--followup-model` picks which model's response id to chain from. -Custom `--base-url` providers plus Gemini/Claude API runs are excluded here because they do not preserve `previous_response_id` in Oracle. +## Control the context -`oracle status` shows parent/child lineage in tree form: +`--file` accepts files, directories, globs, and `!` exclusions. Repeat it to compose the context you want reviewed. Preview the resolved files and token estimate before sending: -```text -Recent Sessions -Status Model Mode Timestamp Chars Cost Slug -completed gpt-5.2-pro api 03/01/2026 09:00 AM 1800 $2.110 architecture-review-parent -completed gpt-5.2-pro api 03/01/2026 09:14 AM 2200 $2.980 ├─ architecture-review-followup -running gpt-5.2-pro api 03/01/2026 09:22 AM 1400 - │ └─ architecture-review-implementation-pass -pending gpt-5.2-pro api 03/01/2026 09:25 AM 900 - └─ architecture-review-risk-check +```bash +oracle --dry-run summary --files-report \ + -p "Audit the model runner for race conditions" \ + --file "src/oracle/**/*.ts" \ + --file "!**/*.test.ts" ``` -## Browser auto-reattach (long Pro runs) +Generated text bundles include stable line numbers so answers can cite `path:line`. Binary and large browser inputs can be uploaded or bundled without converting their contents. The [CLI reference](docs/cli-reference.md) lists the file, size, output, and browser controls. -When browser runs time out (common with long GPT‑5.x Pro responses), Oracle can keep polling the existing ChatGPT tab and capture the final answer without manual `oracle session ` commands. +## Sessions and follow-ups -Enable auto-reattach by setting a non-zero interval: - -- `--browser-auto-reattach-delay` — wait before the first retry (e.g. `30s`) -- `--browser-auto-reattach-interval` — how often to retry (e.g. `2m`) -- `--browser-auto-reattach-timeout` — per-attempt budget (default `2m`) +Oracle stores runs under `~/.oracle/sessions` so long responses can finish in the background and completed answers can be replayed. List recent work with: ```bash -oracle --engine browser \ - --browser-timeout 6m \ - --browser-auto-reattach-delay 30s \ - --browser-auto-reattach-interval 2m \ - --browser-auto-reattach-timeout 2m \ - -p "Run the long UI audit" --file "src/**/*.ts" +oracle status --hours 72 ``` -## Calmer browser runs - -Browser automation can open or control Chrome, so dry-runs and live runs print a short browser control plan before touching ChatGPT. Use it to choose the least disruptive path for shared desktops and agent-driven consults. - -- `--dry-run summary --engine browser ...` previews whether Oracle will launch visible Chrome, hide a new window, attach to an existing browser, or use remote Chrome. -- `--browser-attach-running` and `--remote-chrome ` are the calmest options when a signed-in Chrome is already running with DevTools enabled. -- `--browser-hide-window` is best-effort: Chrome can briefly take focus before Oracle hides it. -- Long GPT-5.5 Pro browser consults are normal. Use `--heartbeat`, `oracle status`, and `oracle session ` instead of starting a duplicate run if the host agent appears to be waiting. -- Successful manual-profile runs close Oracle's own ChatGPT tab and clean up leftover blank startup tabs when no other Oracle browser slots are active. Incomplete runs leave the tab open so `oracle session ` can reattach. - -## Flags you’ll actually use - -| Flag | Purpose | -| ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-p, --prompt ` | Required prompt. | -| `-f, --file ` | Attach files/dirs (globs + `!` excludes). | -| `-e, --engine ` | Choose API or browser (browser is experimental). | -| `-m, --model ` | Built-ins (`gpt-5.5-pro` default, `gpt-5.5`, `gpt-5.4-pro`, `gpt-5.4`, `gpt-5.1-pro`, `gpt-5-pro`, `gpt-5.1`, `gpt-5.1-codex`, `gpt-5.2`, `gpt-5.2-instant`, `gpt-5.2-pro`, `gemini-3.1-pro` API + UI, `gemini-3-pro`, `claude-4.6-sonnet`, `claude-4.1-opus`) plus any OpenRouter id (e.g., `minimax/minimax-m2`, `openai/gpt-4o-mini`). | -| `--models ` | Comma-separated API models (mix built-ins and OpenRouter ids) for multi-model runs. | -| `--reasoning-effort ` | Override reasoning effort for GPT-5.6 API runs. | -| `--reasoning-mode ` | Select the Responses API reasoning mode for GPT-5.6 API runs. Use `--model gpt-5.6-sol --reasoning-mode pro`; Pro is not a separate model slug. | -| `--followup ` | Continue a saved ChatGPT browser conversation or an OpenAI/Azure Responses API run from a stored Oracle session or `resp_...` response id. | -| `--followup-model ` | For multi-model OpenAI/Azure parent sessions, choose which model response to continue from. | -| `--base-url ` | Point API runs at LiteLLM/Azure/OpenRouter/etc. | -| `--chatgpt-url ` | Target a ChatGPT workspace/folder or Temporary Chat URL (browser). | -| `--browser-model-strategy ` | Control ChatGPT model selection in browser mode. Explicit `current` keeps the active model without inheriting configured thinking time; pass `--browser-thinking-time` to change effort. `ignore` skips the picker. | -| `--browser-manual-login` | Skip cookie copy; reuse a persistent automation profile and wait for manual ChatGPT login. | -| `--browser-attach-running` | Reuse your current local browser session through local `DevToolsActivePort` discovery; Oracle opens a dedicated tab instead of launching Chrome (defaults to `127.0.0.1:9222`, or combine with `--remote-chrome ` to hint a different local endpoint). | -| `--browser-tab ` | Reuse an existing ChatGPT tab by `current`, target id, URL, or title substring instead of opening a new tab. | -| `--browser-thinking-time ` | Set ChatGPT thinking-time intensity (browser; Thinking/Pro models only). | -| `--browser-research deep` | Activate ChatGPT Deep Research for broad web research and cited reports (browser only). | -| `--browser-follow-up ` | Browser-only multi-turn consult: submit an additional prompt in the same ChatGPT conversation after the initial answer. Repeat for challenge/revision/final-decision passes. Not supported with Deep Research mode. | -| `--browser-archive ` | Archive completed ChatGPT browser conversations after local artifacts are saved. `auto` archives successful one-shot chats only, and skips project, Deep Research, multi-turn, failed, and incomplete sessions. | -| `--browser-attachments ` | Control browser file delivery: `auto` pastes small text files inline and uploads larger or raw files, `never` requires inline-compatible text files, and `always` uploads files as ChatGPT attachments. | -| `--browser-bundle-files`, `--browser-bundle-format ` | Bundle browser uploads into one attachment. `auto` uses a text bundle for text-only inputs and a byte-preserving ZIP when bundled inputs include raw files; `text` writes a Markdown-style text bundle; `zip` archives the original file bytes. | -| `--browser-port ` | Pin the Chrome DevTools port (WSL/Windows firewall helper). | -| `--browser-inline-cookies[(-file)] ` | Supply cookies without Chrome/Keychain (browser). | -| `--browser-timeout`, `--browser-input-timeout`, `--browser-attachment-timeout` | Control overall/browser input/attachment readiness timeouts (supports h/m/s/ms). | -| `--browser-recheck-delay`, `--browser-recheck-timeout` | Delayed recheck for long Pro runs: wait then retry capture after timeout (supports h/m/s/ms). | -| `--heartbeat ` | Emit API and browser progress heartbeats. Browser mode reports ChatGPT Thinking/Reasoning sidecar liveness metadata when available, without logging reasoning text. | -| `--browser-reuse-wait` | Wait for a shared Chrome profile before launching (parallel browser runs). | -| `--browser-profile-lock-timeout` | Wait for the shared manual-login profile lock before sending (serializes parallel runs). | -| `--browser-max-concurrent-tabs` | Soft limit for simultaneous ChatGPT tabs sharing one manual-login profile (default 3). | -| `--render`, `--copy` | Print and/or copy the assembled markdown bundle. | -| `--wait` | Keep the original CLI attached until completion. API runs execute in the foreground; local Pro browser runs keep a detached worker so unexpected CLI termination cannot stop answer capture. Ctrl-C cancels the worker. | -| `--timeout ` | Overall API deadline (auto = 60m for pro, 120s otherwise; durations like `10m` derive HTTP/stale-session timeouts unless overridden). | -| `--background`, `--no-background` | Force Responses API background mode (create + retrieve) for API runs. | -| `--http-timeout ` | Override the HTTP client timeout; if omitted, explicit `--timeout` values are reused for transport. | -| `--zombie-timeout ` | Override stale-session cutoff used by `oracle status`. | -| `--zombie-last-activity` | Use last log activity to detect stale sessions. | -| `--write-output ` | Save only the final answer (multi-model adds `.` and writes `.oracle.json`). Browser sessions also save transcripts and generated artifacts under `~/.oracle/sessions//artifacts/`. | -| `--allow-partial`, `--partial ` | Multi-model failure policy. Default `fail` exits 1 after printing a structured partial summary; `ok` exits 0 when at least one model succeeds. | -| `--preflight` | Check redacted provider readiness for requested API model(s), then exit without creating a session. | -| `--perf-trace`, `--perf-trace-path ` | Write startup/first-output timing trace JSON; also accepts `--perf-trace=/tmp/oracle.json`, `ORACLE_PERF_TRACE=1`, or `ORACLE_PERF_TRACE=/tmp/oracle.json`. | -| `--files-report` | Print per-file token usage. | -| `--dry-run [summary\|json\|full]` | Preview without sending. | -| `--remote-host`, `--remote-token` | Use a remote `oracle serve` host (browser). | -| `--remote-chrome ` | Attach to an existing remote Chrome session (browser), or when combined with `--browser-attach-running` use this host:port as the local attach hint. | -| `--youtube ` | YouTube video URL to analyze (Gemini browser mode). | -| `--generate-image ` | Generate image and save to file (Gemini browser mode; ChatGPT browser mode saves downloadable image artifacts when present). Extra ChatGPT images save as numbered siblings. | -| `--edit-image ` | Edit existing image with `--output` (Gemini browser mode). For ChatGPT browser mode, attach source images with `--file` and use `--generate-image` for the output path. | -| `--provider openai\|azure\|auto`, `--no-azure`, `--route` | Choose or inspect API provider routing; `openai` / `--no-azure` ignores Azure env/config for the run. | -| `--azure-endpoint`, `--azure-deployment`, `--azure-api-version` | Target Azure OpenAI endpoints (picks Azure client automatically). | - -## Configuration - -Put defaults in `~/.oracle/config.json` (JSON5). Example: - -```json5 -{ - model: "gpt-5.5-pro", - engine: "api", - filesReport: true, - browser: { - chatgptUrl: "https://chatgpt.com/g/g-p-691edc9fec088191b553a35093da1ea8-oracle/project", - archiveConversations: "auto", - }, -} -``` +Use `oracle session` to reattach to a run, `oracle restart` to repeat one, or `--followup` to continue a supported API or ChatGPT conversation with more context. See [sessions](docs/sessions.md) and [follow-ups](docs/followup.md) for the lifecycle and provider limits. -Use `browser.chatgptUrl` (or the legacy alias `browser.url`) to target a specific ChatGPT workspace/folder for browser automation. -See [docs/configuration.md](docs/configuration.md) for precedence and full schema. +## Multiple models and automation -When several agents share one manual-login ChatGPT profile, Oracle coordinates browser tab slots through that profile. Extra runs wait and log that they are waiting for a ChatGPT browser slot instead of crashing because another Codex/Claude/CLI run is already using the browser. For the most reliable shared-agent setup, keep one signed-in Chrome open with remote debugging and point callers at it with `--remote-chrome `; direct manual-login launches are guarded so parallel callers reuse the first reachable Chrome instead of racing separate launches on the same profile. +`--models` runs an API panel and records per-model usage, cost, output, and partial failures in one session. `oracle doctor --providers` inspects readiness for the selected models without exposing credentials. The [multi-model guide](docs/multimodel.md) covers routing and output files. -Advanced flags +For agent integrations, run the `oracle-mcp` stdio server or install the Oracle skill from this repository. See [MCP setup](docs/mcp.md) and [agent setup](docs/agents.md) for Claude Code, Codex, Cursor, and other MCP clients. -| Area | Flags | -| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Browser | `--browser-manual-login`, `--browser-attach-running`, `--browser-thinking-time`, `--browser-research`, `--browser-follow-up`, `--browser-archive`, `--browser-timeout`, `--browser-input-timeout`, `--browser-attachment-timeout`, `--browser-recheck-delay`, `--browser-recheck-timeout`, `--browser-reuse-wait`, `--browser-profile-lock-timeout`, `--browser-max-concurrent-tabs`, `--browser-auto-reattach-delay`, `--browser-auto-reattach-interval`, `--browser-auto-reattach-timeout`, `--browser-cookie-wait`, `--browser-inline-cookies[(-file)]`, `--browser-attachments`, `--browser-inline-files`, `--browser-bundle-files`, `--browser-bundle-format`, `--browser-keep-browser`, `--browser-headless`, `--browser-hide-window`, `--browser-no-cookie-sync`, `--browser-allow-cookie-errors`, `--browser-chrome-path`, `--browser-cookie-path`, `--chatgpt-url` | -| Run control | `--background`, `--no-background`, `--http-timeout`, `--zombie-timeout`, `--zombie-last-activity` | -| Azure/OpenAI | `--azure-endpoint`, `--azure-deployment`, `--azure-api-version`, `--base-url` | +## Documentation -Remote browser example +| Topic | Guide | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| Installation and first run | [Install](docs/install.md) · [Quickstart](docs/quickstart.md) | +| Browser automation | [Browser mode](docs/browser-mode.md) · [Linux](docs/linux.md) · [Windows](docs/windows.md) | +| Providers | [OpenAI and Azure](docs/openai-endpoints.md) · [Anthropic](docs/anthropic.md) · [Gemini](docs/gemini.md) · [OpenRouter](docs/openrouter.md) | +| Runs and models | [Sessions](docs/sessions.md) · [Follow-ups](docs/followup.md) · [Multi-model](docs/multimodel.md) | +| Configuration and commands | [Configuration](docs/configuration.md) · [CLI reference](docs/cli-reference.md) | +| Agent integrations | [Agents](docs/agents.md) · [MCP](docs/mcp.md) · [Bridge](docs/bridge.md) | -```bash -# Host (signed-in Chrome): launch serve -oracle serve --host 0.0.0.0:9473 --token secret123 +## Related projects -# Client: target that host -oracle --engine browser --remote-host 192.168.1.10:9473 --remote-token secret123 -p "Run the UI smoke" --file "src/**/*.ts" +- [Trimmy](https://trimmy.app) — Flatten multiline shell snippets so they paste and run once. +- [CodexBar](https://codexbar.app) — Keep Codex token windows visible in the macOS menu bar. +- [MCPorter](https://mcporter.dev) — TypeScript toolkit and CLI for Model Context Protocol servers. -# If cookies can’t sync, pass them inline (JSON/base64) -oracle --engine browser --browser-inline-cookies-file ~/.oracle/cookies.json -p "Run the UI smoke" --file "src/**/*.ts" -``` +The name was inspired by [Amp's Oracle](https://ampcode.com/news/oracle). -Session management +## Development ```bash -# Prune stored sessions (default path ~/.oracle/sessions; override ORACLE_HOME_DIR) -oracle status --clear --hours 168 +pnpm install +pnpm check +pnpm test +pnpm build +pnpm docs:check ``` -## More docs - -- Bridge (Windows host → Linux client): [docs/bridge.md](docs/bridge.md) -- Browser mode & forks: [docs/browser-mode.md](docs/browser-mode.md) (includes `oracle serve` remote service), [docs/chromium-forks.md](docs/chromium-forks.md), [docs/linux.md](docs/linux.md) -- MCP: [docs/mcp.md](docs/mcp.md) -- OpenAI/Azure/OpenRouter endpoints: [docs/openai-endpoints.md](docs/openai-endpoints.md), [docs/openrouter.md](docs/openrouter.md) -- Manual smokes: [docs/manual-tests.md](docs/manual-tests.md) -- Testing: [docs/testing.md](docs/testing.md) - -If you’re looking for an even more powerful context-management tool, check out https://repoprompt.com -Name inspired by: https://ampcode.com/news/oracle +Manual browser and provider tests are documented in [docs/manual-tests.md](docs/manual-tests.md). -## More free stuff from steipete +## License -- ✂️ [Trimmy](https://trimmy.app) — “Paste once, run once.” Flatten multi-line shell snippets so they paste and run. -- 🟦🟩 [CodexBar](https://codexbar.app) — Keep Codex token windows visible in your macOS menu bar. -- 🧳 [MCPorter](https://mcporter.dev) — TypeScript toolkit + CLI for Model Context Protocol servers. +MIT. See [LICENSE](LICENSE).