Skip to content

docs: add getting started requirements #185

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
edwin-zvs merged 1 commit into from
May 23, 2026
Merged

docs: add getting started requirements #185

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
23 changes: 19 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,22 @@ you. Remote control from your phone when you're in motion.

## Getting started

### 1. Install
### 1. Requirements

Bring the agents you want to run. `agentd` wraps the CLIs already on your
machine, so install whichever harnesses you use, keep them on `PATH`, and log in
first:

- **Codex** — install the `codex` CLI and complete its OAuth login.
- **Claude Code** — install the `claude` CLI and complete its OAuth login.
- **Antigravity** — install the `agy` CLI and complete its OAuth login.
- **Zarvis** — built in to agentd. Today it uses Codex CLI OAuth for OpenAI GPT
models, or a local Ollama install for local models.

Once those CLIs are available and authenticated, `agentd` can create and resume
their sessions from the fleet TUI.

### 2. Install

The installer downloads the right prebuilt binary for your platform, verifies its
SHA-256 checksum, and drops every binary into one directory on your PATH:
Expand All @@ -40,7 +55,7 @@ curl -fsSL https://raw.githubusercontent.com/zarvis-ai/agentd/main/install.sh |
Pin a version or change the directory with `AGENTD_VERSION=v0.2.0` /
`AGENTD_BIN_DIR=/usr/local/bin`.

### 2. Start the daemon
### 3. Start the daemon

```sh
agentd
Expand All @@ -49,7 +64,7 @@ agentd
Leave this running. It owns sessions, persists state, and exposes the local IPC
socket used by clients.

### 3. Open the fleet TUI
### 4. Open the fleet TUI

In a second shell:

Expand All @@ -61,7 +76,7 @@ Use `?` for help and `M-x` for the command palette. From the TUI you can create
sessions, switch between agents, send input, inspect diffs, and interrupt or stop
work without leaving the flow.

### 4. Start crack the matrix
### 5. Start crack the matrix

Happy hacking. Chase the dream idea from your terminal: ask Codex, Claude Code,
Antigravity, and [Zarvis](docs/zarvis.md) to dive into the hard parts, then keep
Expand Down
Loading