Skip to content

Commit 62891d3

Browse files
yjwongclaude
andcommitted
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>
1 parent 0f37b11 commit 62891d3

1 file changed

Lines changed: 8 additions & 16 deletions

File tree

website/src/content/docs/getting-started/installation.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,7 @@ sidebar:
77

88
## Prerequisites
99

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.
2111

2212
## Download
2313

@@ -59,10 +49,6 @@ On macOS, OpenShrimp is also available as a menu bar app. Download the `.dmg` fr
5949
- Start/stop the bot, open config, view logs — all from the menu bar
6050
- "Start at Login" toggle for automatic launch
6151

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-
6652
## Run the setup wizard
6753

6854
On first run, the binary launches an interactive setup wizard:
@@ -77,10 +63,16 @@ The wizard walks you through:
7763
2. Your Telegram user ID (from [@userinfobot](https://t.me/userinfobot))
7864
3. Creating your first context (project directory, description, model)
7965

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/).
8167

8268
On subsequent runs, the binary starts instantly.
8369

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+
8476
## Building from source
8577

8678
If you need to build from source (older Linux distros, development, etc.), see [Building from Source](/reference/building-from-source/).

0 commit comments

Comments
 (0)