Skip to content

Commit 8e36e53

Browse files
authored
docs: add Quick Install section near top of README (#149)
- Add `## Quick Install` block (gh auth login + npm install -g + run) immediately after the warning callouts, so new users see the install path within the first screen - Link forward to the existing `## Install and Run` section for Docker, source builds, and full prerequisites - Prettier also realigned the capability table dividers in `How It Works` (pre-existing alignment drift from when the `execute_bash` row was added) — pure formatting, no content change Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>
1 parent 5a66988 commit 8e36e53

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ It is built for useful, bounded work: data analysis, document generation, API wo
88
>
99
> **Platform note:** HyperAgent requires hardware virtualization: Linux with KVM, Azure Linux with MSHV, Windows with WHP, or WSL2 with KVM. It does not currently run on macOS [because of this Hyperlight issue](https://github.com/hyperlight-dev/hyperlight/issues/45).
1010
11+
## Quick Install
12+
13+
```bash
14+
# Authenticate with GitHub (Copilot access required)
15+
gh auth login
16+
17+
# Install and run
18+
npm install -g @hyperlight-dev/hyperagent
19+
hyperagent
20+
```
21+
22+
Requires Node.js 22+ and hardware virtualization (Linux/KVM, Windows/WHP, Azure Linux/MSHV, or WSL2/KVM). For Docker, building from source, and full prerequisites, see [Install and Run](#install-and-run) below.
23+
1124
## Why HyperAgent?
1225

1326
Most agent CLIs are powerful because they can touch your machine directly: shell commands, file edits, network calls, local tools, credentials, and long-lived process state. That is useful, but it also means a bad instruction, hallucinated command, or prompt-injected webpage can become real host activity very quickly.
@@ -121,14 +134,14 @@ User prompt
121134

122135
The sandbox has no direct filesystem, network, shell, or process access. Capabilities are added deliberately:
123136

124-
| Capability | How it is exposed |
125-
| ---------------- | ---------------------------------------------------------------- |
126-
| Files | `fs-read` and `fs-write` plugins with path jails |
127-
| HTTP | `fetch` plugin with domain allowlists and SSRF checks |
137+
| Capability | How it is exposed |
138+
| ---------------- | ------------------------------------------------------------------------- |
139+
| Files | `fs-read` and `fs-write` plugins with path jails |
140+
| HTTP | `fetch` plugin with domain allowlists and SSRF checks |
128141
| Bash commands | `execute_bash` — sandboxed pure-JS interpreter (ls, grep, jq, curl, etc.) |
129-
| Reusable code | `ha:*` system and user modules |
130-
| External systems | MCP servers exposed as typed `host:mcp-*` modules |
131-
| Bigger jobs | Profiles that raise limits; profile tools can enable plugin sets |
142+
| Reusable code | `ha:*` system and user modules |
143+
| External systems | MCP servers exposed as typed `host:mcp-*` modules |
144+
| Bigger jobs | Profiles that raise limits; profile tools can enable plugin sets |
132145

133146
## Built-In Modules
134147

0 commit comments

Comments
 (0)