Skip to content

Commit 340e768

Browse files
committed
docs: add CI badges, requirements, interactive installer
- CI and Integration status badges in README header - Requirements table (OS, RAM, CPU, disk) - Linux platform note (tested on Ubuntu 24.04 + Arch Linux) - install.sh: interactive one-command installer - Detects distro (Ubuntu/Arch), installs prereqs - Clones repo or uses existing clone - Runs setup.sh automatically - Walks through secrets with validation + links - Writes .env with correct permissions - Offers to launch agent in tmux - README Quick Start updated to feature installer - Tested on fresh Ubuntu 24.04 and Arch Linux droplets
1 parent 1c530b6 commit 340e768

3 files changed

Lines changed: 429 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,9 @@ Agent runtime layout:
7676
## Development Workflow
7777

7878
```bash
79+
# First-time install (interactive — handles everything)
80+
sudo ~/hornet/install.sh
81+
7982
# Edit source files directly in ~/hornet/
8083

8184
# Deploy to agent runtime

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,21 @@ Agents work on real files in real repos — no sandbox friction. They make real
3333
## Quick Start
3434

3535
```bash
36-
# Clone (as admin — source lives in admin's home, not agent's)
37-
git clone <your-hornet-repo-url> ~/hornet
36+
git clone https://github.com/modem-dev/hornet.git ~/hornet
37+
sudo ~/hornet/install.sh
38+
```
39+
40+
The installer detects your distro, installs dependencies, creates the agent user, sets up the firewall, and walks you through API keys interactively. Takes ~2 minutes.
41+
42+
<details>
43+
<summary>Manual setup (without installer)</summary>
3844

45+
```bash
3946
# Setup (creates user, firewall, permissions — run as root)
4047
sudo bash ~/hornet/setup.sh <admin_username>
4148

4249
# Add secrets
43-
sudo su - hornet_agent -c 'vim ~/.config/.env'
50+
sudo -u hornet_agent vim ~/.config/.env
4451

4552
# Deploy source → agent runtime
4653
~/hornet/bin/deploy.sh
@@ -49,6 +56,9 @@ sudo su - hornet_agent -c 'vim ~/.config/.env'
4956
sudo -u hornet_agent ~/runtime/start.sh
5057
```
5158

59+
See [CONFIGURATION.md](CONFIGURATION.md) for the full list of secrets and how to obtain them.
60+
</details>
61+
5262
## Configuration
5363

5464
Secrets and configuration live in `~hornet_agent/.config/.env` (not in repo, 600 perms).

0 commit comments

Comments
 (0)