You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): full sync with private — OTP login + 10x.in positioning
Brings the public-repo README up to parity with the npm-package
README. Adds:
- "Sign in" section leading with `openanalyst account login`, the
OTP flow that ships in 2.0.36 — no API key juggling, no browser.
- 10x.in positioning: free account, free credits, single credit
balance across every frontier model. Recommended path.
- Skills marketplace (10x.in/skills) + plugin catalog
(10x.in/plugins) explicitly called out so users see how the
CLI extends beyond raw inference.
- BYOP (Anthropic / OpenAI / Gemini / xAI / OpenRouter / Bedrock)
still surfaced as first-class — explicitly supported, can be
combined with an OpenAnalyst login.
- Three-way usage (TUI / web console / self-host) and workspace
jail explanations match the private README verbatim.
This is the page visible at github.com/OpenAnalystInc/cli — the
shop window. Source code still lives only in the private repo.
Public distribution repository for the latest OpenAnalyst CLI binaries, install scripts, and documentation.
3
+
**The Universal AI Agent for Your Terminal — and now your Browser.**
4
+
5
+
OpenAnalyst is a single, focused AI development tool you can use three ways with the same install: as a rich terminal UI (TUI), as a browser-based web console pointed at your local machine, or as a self-hosted service on your own cloud infrastructure. Workspace-jailed by default, BYO-key for every major provider, zero lock-in.
4
6
5
7
## Install
6
8
9
+
The fastest path on any OS:
10
+
7
11
```bash
8
12
npm install -g @openanalystinc/openanalyst-cli
9
13
```
10
14
11
-
macOS / Linux:
15
+
That gives you the `openanalyst` (and short `oa`) binary on your `$PATH`. If you prefer not to use npm:
You have three ways to give the CLI credentials. **We recommend signing in with an OpenAnalyst account** — you get one place to pay, one credit balance across every frontier model, plus the [10x.in](https://10x.in) skills & plugins catalog that turns the CLI into your team's dedicated workflow runner.
38
+
39
+
**1. Sign in with your OpenAnalyst account (recommended).** Free to start. One command, no API key juggling:
40
+
41
+
```bash
42
+
openanalyst account login
43
+
```
44
+
45
+
Don't have an account yet? Create one in 30 seconds at **[10x.in](https://10x.in)** — that's where you sign up, get free credits, manage plans, and grab an OpenAnalyst API key if you'd rather paste one in. The same login gives you:
46
+
47
+
- the full OpenAnalyst-routed model catalog — **Beta, Max, GPT-5.4, Claude Opus 4.7, Gemini 3 Pro** — through one balance, no per-provider keys.
48
+
- the **skills marketplace** at [10x.in/skills](https://10x.in/skills) — install pre-built `/skills` like `/code-review`, `/release-notes`, `/security-audit` that run as first-class slash commands inside the CLI.
49
+
- the **plugin catalog** at [10x.in/plugins](https://10x.in/plugins) — extend the CLI with custom tools (CRM connectors, internal-doc readers, deploy helpers) maintained by your team or the community.
50
+
- usage analytics, team seats, and SSO at [10x.in/team](https://10x.in/team).
51
+
52
+
The CLI will prompt for your email, send a 6-digit code, you paste it back, and you're signed in. No browser, no copy-paste of long keys.
53
+
54
+
```bash
55
+
openanalyst account status # see plan + credits left
56
+
openanalyst account logout# sign out
57
+
```
58
+
59
+
**2. Paste an OpenAnalyst API key.** Already have an `sk-oa-v1-*` key from [10x.in](https://10x.in) → Dashboard → API Keys?
24
60
25
61
```bash
62
+
export OPENANALYST_API_KEY=sk-oa-v1-...
26
63
openanalyst
27
-
openanalyst --notui
28
-
openanalyst --serve 8080
64
+
```
65
+
66
+
…or set it once in `~/.openanalyst/.env` and forget it.
67
+
68
+
**3. Bring your own provider keys (BYOP).** Prefer to talk to Anthropic, OpenAI, Gemini, xAI, OpenRouter, or Bedrock directly with your own keys? Totally supported — drop them in `~/.openanalyst/.env` or paste them into the web console's Settings → Providers tab. The CLI auto-discovers what's available and shows only the models you can actually use. You can mix BYOP with an OpenAnalyst login; both work side-by-side and you pick which one inference uses per-session.
69
+
70
+
## Three ways to use it
71
+
72
+
**1. TUI in your terminal.** Just type `openanalyst` in any folder. The whole project becomes your workspace; the model can read and edit files only inside that folder.
73
+
74
+
**2. Web console in your browser.** Run `openanalyst --serve` from your project folder. Open the OpenAnalyst web console (hosted at `openanalystinc.github.io/cli/console` or self-built from the `web-ui/` source) and point it at `http://localhost:3080`. The Settings → **Account** tab gives you the same email/OTP sign-in flow as the CLI; the **Providers** tab lets you paste any other API keys you already have. The file viewer on the right side shows everything the model creates in your workspace, with one-click download.
75
+
76
+
**3. Self-host for your team.** Deploy `openanalyst --serve` on your AWS / Fly / Render / VPS. Build the `web-ui/` SPA pointing at your backend URL. Drop the static files on S3 + CloudFront. One client deployment per workspace, locked to one folder, fully your infrastructure.
77
+
78
+
## Usage
79
+
80
+
```bash
81
+
openanalyst # launch the default interactive TUI
82
+
openanalyst "what does this repo do?"# one-shot prompt, prints to stdout
83
+
openanalyst account login # sign in with email + OTP (no browser)
84
+
openanalyst account status # show your plan + credits left
85
+
openanalyst account logout# sign out
86
+
openanalyst --resume # restore the most recent saved session on launch
87
+
openanalyst --notui # backend CLI without the TUI
88
+
openanalyst --serve 8080 # hosted HTTP session API
openanalyst --acp --session-id ID # ACP session pinned to a persistent id
91
+
openanalyst --acp --session-id ID --conversation-id CONV # plus a stable conversation handle
92
+
openanalyst --control-socket # local-only IPC for external apps to spawn / list / load sessions
29
93
```
30
94
31
95
-`openanalyst` launches the default interactive TUI.
96
+
-`openanalyst --resume` rehydrates the most recently saved session on startup, equivalent to running `/resume` after launch.
32
97
-`openanalyst --notui` runs the backend CLI without the TUI.
33
98
-`openanalyst --serve 8080` exposes the hosted session API:
34
99
-`POST /sessions`
35
100
-`POST /sessions/{id}/message`
36
101
-`GET /sessions/{id}/events`
102
+
-`openanalyst --acp` speaks Agent Client Protocol (JSON-RPC 2.0 over stdio) — used by IDE integrations and the embedding-app pattern below.
103
+
-`openanalyst --control-socket` runs a local-only Unix domain socket (Linux/macOS) or named pipe (Windows) at `~/.openanalyst/control.sock` for orchestrators and external apps. Token-gated via `~/.openanalyst/control.token` (mode 0600 on Unix). Exposes `authenticate`, `list`, `loadSession`, `spawn`, `shutdown`.
104
+
105
+
## Persistent multi-session
106
+
107
+
Pass `--session-id` and `--conversation-id` to `--acp` to make the CLI durable across restarts. Sessions are persisted to `~/.openanalyst/sessions.db` (single SQLite file, WAL mode, cross-process safe). The same `session_id` re-attached later picks up exactly where the previous process left off. External apps remember the stable `conversation_id` — `session_id` is the runtime handle and may rotate; `conversation_id` is the long-lived thread.
108
+
109
+
The Agent tool accepts an `isolation` parameter — set to `"process"` to spawn the sub-agent as a child `openanalyst-cli --acp` subprocess for crash isolation, true parallel CPU work, and restart durability. Default is `"thread"` for cheap, short-lived workers.
110
+
111
+
## Workspace jail
112
+
113
+
Every file operation is jailed to the folder the CLI was launched from. `Read`, `Write`, `Edit`, `Glob`, `Grep`, and `Bash` all canonicalize the requested path and refuse anything outside the workspace root. Path traversal (`../../etc/passwd`) is blocked. Symlinks are resolved before the check.
114
+
115
+
This is admin-controlled. The end user using the web console cannot disable the jail. Only the person who starts the server can — by setting `OPENANALYST_DISABLE_WORKSPACE_JAIL=1` before launching. Trusted external paths (e.g., shared library folders) can be allowlisted in `~/.openanalyst/settings.json` under `workspace_allow_paths`.
37
116
38
117
## Providers
39
118
40
-
OpenAnalyst CLI supports:
119
+
OpenAnalyst CLI routes to any of these — pick whichever you want, mix and match:
120
+
121
+
-**OpenAnalyst (recommended)** — sign in with `openanalyst account login` or paste an `sk-oa-v1-*` key from [10x.in](https://10x.in). One credit balance, every frontier model: Beta, Max, GPT-5.4, Claude Opus 4.7, Gemini 3 Pro. Free credits on sign-up.
-**Stability AI / Gemini Imagen / OpenAI Images** — image generation via `/image`.
129
+
-**Brave Search / Tavily / Serper / Exa** — web search for `/scrape` and the WebSearch tool.
130
+
131
+
Set any of these as environment variables, drop them in `~/.openanalyst/.env`, or paste them in the web console's Settings → Providers tab. They're stored encrypted on disk.
132
+
133
+
## Skills & plugins (10x.in)
134
+
135
+
Beyond the model providers, the CLI installs **skills** (typed slash commands) and **plugins** (custom tools) from the [10x.in](https://10x.in) catalog. Signed-in users get access to:
136
+
137
+
-**[10x.in/skills](https://10x.in/skills)** — curated skills like `/code-review`, `/release-notes`, `/security-audit`, `/standup`, `/onboarding`. Install with `openanalyst skills install <name>` and they show up in the slash-command palette instantly.
-**Skill authoring** — write your own skill at [10x.in/skills/new](https://10x.in/skills/new), share it with your team (private) or the world (public). The `/skills` directory inside the CLI honors both local and remote sources.
41
140
42
-
- OpenAnalyst
43
-
- Anthropic / Claude
44
-
- OpenAI / GPT / Codex
45
-
- Google Gemini
46
-
- xAI / Grok
47
-
- OpenRouter
48
-
- Amazon Bedrock
49
-
- Stability AI
141
+
The skills & plugins index is fetched at startup using your account credentials, so they "just work" once you've run `openanalyst account login`.
50
142
51
143
## Docs
52
144
@@ -64,22 +156,3 @@ This repository is intentionally limited to public release assets:
64
156
- npm package metadata
65
157
66
158
Source development for the private release pipeline happens separately.
0 commit comments