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(installation): drop Claude CLI prereq, document /start and /login
The Agent SDK now bundles the Claude Code CLI, so users no longer
need to install it separately. Replace the prerequisite with a brief
note pointing to /login (OAuth via Mini App) or ANTHROPIC_API_KEY,
and add an "Authenticate Claude" section covering /start and /login.
Also fix the config path to cover both Linux and macOS.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: website/src/content/docs/getting-started/installation.md
+8-16Lines changed: 8 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,7 @@ sidebar:
7
7
8
8
## Prerequisites
9
9
10
-
-**Claude CLI** — the Anthropic Claude Code CLI, installed and authenticated
11
-
12
-
### Install and authenticate Claude CLI
13
-
14
-
Follow the [official instructions](https://docs.anthropic.com/en/docs/claude-code/getting-started) to install Claude Code. Then authenticate:
15
-
16
-
```bash
17
-
claude # follow the prompts to log in
18
-
```
19
-
20
-
You can also set `ANTHROPIC_API_KEY` in your environment if you prefer API key authentication.
10
+
OpenShrimp bundles the Claude Code CLI via the Agent SDK, so there's nothing to install separately. You just need to authenticate Claude — either by running `/login` from inside the bot (see [Authenticate Claude](#authenticate-claude) below), or by setting `ANTHROPIC_API_KEY` in your environment.
21
11
22
12
## Download
23
13
@@ -59,10 +49,6 @@ On macOS, OpenShrimp is also available as a menu bar app. Download the `.dmg` fr
59
49
- Start/stop the bot, open config, view logs — all from the menu bar
60
50
- "Start at Login" toggle for automatic launch
61
51
62
-
:::note
63
-
The macOS app is currently unsigned. On first launch, macOS will block it — right-click the app and choose "Open" to bypass Gatekeeper, or go to System Settings → Privacy & Security and click "Open Anyway".
64
-
:::
65
-
66
52
## Run the setup wizard
67
53
68
54
On first run, the binary launches an interactive setup wizard:
@@ -77,10 +63,16 @@ The wizard walks you through:
77
63
2. Your Telegram user ID (from [@userinfobot](https://t.me/userinfobot))
78
64
3. Creating your first context (project directory, description, model)
79
65
80
-
It writes the config to `~/.config/openshrimp/config.yaml`. You can also set this up manually — see [Configuration](/getting-started/configuration/).
66
+
It writes the config to a platform-specific location (`~/.config/openshrimp/config.yaml` on Linux, `~/Library/Application Support/openshrimp/config.yaml` on macOS). You can also set this up manually — see [Configuration](/getting-started/configuration/).
81
67
82
68
On subsequent runs, the binary starts instantly.
83
69
70
+
## Authenticate Claude
71
+
72
+
Once the bot is running, open it in Telegram and send `/start` to see a welcome message confirming you're connected and showing your current context.
73
+
74
+
If you haven't set `ANTHROPIC_API_KEY`, send `/login` (in a private chat) to authenticate Claude Code via OAuth. This opens a Mini App that runs the same OAuth flow you'd get from the Claude Code CLI — paste the resulting token to finish login. Use `/login` again any time you need to re-authenticate.
75
+
84
76
## Building from source
85
77
86
78
If you need to build from source (older Linux distros, development, etc.), see [Building from Source](/reference/building-from-source/).
0 commit comments