You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: README.md
+20-7Lines changed: 20 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,19 @@ It is built for useful, bounded work: data analysis, document generation, API wo
8
8
>
9
9
> **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).
10
10
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
+
11
24
## Why HyperAgent?
12
25
13
26
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
121
134
122
135
The sandbox has no direct filesystem, network, shell, or process access. Capabilities are added deliberately:
0 commit comments