Skip to content

docs: add Quick Install section near top of README #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simongdavies merged 1 commit into from
May 15, 2026
+20 −7
Merged

docs: add Quick Install section near top of README #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ It is built for useful, bounded work: data analysis, document generation, API wo
>
> **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).

## Quick Install

```bash
# Authenticate with GitHub (Copilot access required)
gh auth login

# Install and run
npm install -g @hyperlight-dev/hyperagent
hyperagent
```

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.

## Why HyperAgent?

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.
Expand Down Expand Up @@ -121,14 +134,14 @@ User prompt

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

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

## Built-In Modules

Expand Down