Skip to content

Commit e0f2c38

Browse files
ziggyclaude
andcommitted
README: rewrite install section as guided walkthrough
Lead with the experience — dedicated machine, install Claude Code, clone, let Claude walk you through setup. Clearer for first-timers. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7450c96 commit e0f2c38

1 file changed

Lines changed: 21 additions & 7 deletions

File tree

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,48 @@
77

88
<p align="center">
99
<a href="https://ghostclaw.io">Website</a> &nbsp;·&nbsp;
10-
<a href="#install">Install</a> &nbsp;·&nbsp;
10+
<a href="https://ghostclaw.io/why.html">Why GhostClaw</a> &nbsp;·&nbsp;
11+
<a href="#get-started">Install</a> &nbsp;·&nbsp;
1112
<a href="#whats-included">Features</a> &nbsp;·&nbsp;
1213
<a href="https://t.me/+8qJbqxzBQAZkYTNk"><img src="https://img.shields.io/badge/Telegram-Community-26A5E4?logo=telegram&logoColor=white" alt="Telegram Community"></a>
1314
</p>
1415

1516
---
1617

17-
A bare-metal AI agent that runs on your hardware, under your control. Single Node.js process, SQLite for state, Claude as a child process. No containers, no cloud, no orchestration. Telegram, WhatsApp, email, cron. 10 minutes to set up.
18+
An AI agent that lives on your computer and works for you. Message it on Telegram like a co-worker. It reads email, does research, runs scheduled tasks, and has full access to its machine. No containers, no cloud, no orchestration. 10 minutes to set up.
1819

19-
## Install
20+
## Get started
21+
22+
Best on a dedicated machine — a Mac Mini, an old laptop, a VPS. Fresh accounts, let it grow. You _can_ run it on your daily driver, but GhostClaw runs autonomously, installs things, writes files, runs tasks on its own schedule. Give it a machine it can own.
23+
24+
### 1. Install Claude Code
25+
26+
If you haven't already — open Terminal and run:
27+
28+
```bash
29+
npm install -g @anthropic-ai/claude-code
30+
```
31+
32+
### 2. Clone and launch
2033

2134
```bash
22-
npm install -g @anthropic-ai/claude-code # if you haven't already
2335
git clone https://github.com/b1rdmania/ghostclaw.git
2436
cd ghostclaw
2537
npm install
2638
claude
2739
```
2840

29-
Inside Claude Code:
41+
### 3. Let Claude walk you through setup
42+
43+
Inside Claude Code, type:
3044

3145
```
3246
/setup-ghostclaw
3347
```
3448

35-
The wizard handles API keys, Telegram bot, personality, background service. About 10 minutes.
49+
Claude handles everything interactively — Telegram bot from BotFather, API keys, personality, background service. About 10 minutes. You just answer questions.
3650

37-
**Requirements:** Node.js 20+, Claude Code, macOS or Linux, Claude Max or API key.
51+
**Requirements:** Node.js 20+, macOS or Linux, Claude Max or API key.
3852

3953
## What's included
4054

0 commit comments

Comments
 (0)