Skip to content

Commit e061f54

Browse files
committed
docs: move prerequisites above install, add brew/curl install options, interactive quick start
1 parent ee801bb commit e061f54

File tree

1 file changed

+39
-11
lines changed

1 file changed

+39
-11
lines changed

README.md

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,32 @@ AI agents need persistent infrastructure, not ephemeral containers. They need to
4545
- **Cheap** -- Hetzner VMs start at $3.49/month. No markup, no platform fee.
4646
- **Yours** -- Apache 2.0. Fork it, extend it, run it on your own terms.
4747

48+
## Prerequisites
49+
50+
You need three things before getting started:
51+
52+
**1. Hetzner Cloud account** -- [console.hetzner.cloud](https://console.hetzner.cloud). Create a project, then generate an API token with Read & Write permissions under Security > API Tokens.
53+
54+
**2. Cloudflare account with a domain** -- [dash.cloudflare.com](https://dash.cloudflare.com). Get your Zone ID from the domain overview sidebar. Create an API token with Edit zone DNS permission.
55+
56+
**3. SSH key on Hetzner** -- Upload your public key at Hetzner Console > Security > SSH Keys. If you need one: `ssh-keygen -t ed25519`.
57+
58+
That's it. Once you have these, everything else is automated.
59+
4860
## Install
4961

62+
**Homebrew** (recommended):
63+
```bash
64+
brew tap ghostwright/specter
65+
brew install specter
66+
```
67+
68+
**Shell script:**
69+
```bash
70+
curl -sSL https://raw.githubusercontent.com/ghostwright/specter/main/scripts/install.sh | sh
71+
```
72+
73+
**From source** (for development):
5074
```bash
5175
git clone https://github.com/ghostwright/specter.git
5276
cd specter && make build
@@ -55,8 +79,22 @@ cd specter && make build
5579

5680
## Quick Start
5781

82+
### Interactive (recommended)
83+
84+
Just launch Specter. The TUI guides you through everything.
85+
86+
```bash
87+
specter
88+
```
89+
90+
First run detects no config and walks you through setup. Then press `d` to deploy your first agent, `s` to SSH in, `l` for logs. No flags to remember.
91+
92+
### CLI
93+
94+
If you prefer commands or need automation:
95+
5896
```bash
59-
# 1. Setup wizard (validates tokens, creates firewall)
97+
# 1. Setup (validates tokens, creates firewall)
6098
specter init
6199

62100
# 2. Build golden snapshot (first time only, ~5 min)
@@ -258,16 +296,6 @@ The snapshot is built on the smallest x86 server (cx23, 40 GB disk) to minimize
258296
- **Dual firewall** -- Hetzner Cloud Firewall + ufw, only ports 22/80/443
259297
- **SSH** -- Uses StrictHostKeyChecking=no (known trade-off for ephemeral VMs)
260298

261-
## Prerequisites
262-
263-
Before running `specter init`, you need:
264-
265-
**1. Hetzner Cloud account** -- [console.hetzner.cloud](https://console.hetzner.cloud). Create a project, then generate an API token with Read & Write permissions under Security > API Tokens.
266-
267-
**2. Cloudflare account with a domain** -- [dash.cloudflare.com](https://dash.cloudflare.com). Get your Zone ID from the domain overview sidebar. Create an API token with Edit zone DNS permission.
268-
269-
**3. SSH key on Hetzner** -- Upload your public key at Hetzner Console > Security > SSH Keys. If you need one: `ssh-keygen -t ed25519`.
270-
271299
## FAQ
272300

273301
**How much does it cost?**

0 commit comments

Comments
 (0)