Skip to content

docs: correct and explain the first task workflow #10

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
rustfuture merged 1 commit into from
Oct 2, 2026
Merged

docs: correct and explain the first task workflow #10

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
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ Rust Agent Runtime executes automated coding tasks using language models while e

## Quick start

Rust 1.85 or newer is required.
You need Git and Rust 1.85 or newer, including Cargo ([rustup](https://rustup.rs/)). The first build downloads Cargo dependencies. Run the commands below from the cloned repository.

### Build and test

```bash
git clone https://github.com/rustfuture/rust-agent-runtime.git
cd rust-agent-runtime

cargo build --locked
cargo test --locked
```
Expand All @@ -39,18 +42,25 @@ cargo run --locked -- status ./runtime-data
cargo run --locked -- cancel ./runtime-data demo-task
```

Status lists `demo-task` as queued after enqueue and cancelled after cancel. Records are saved in `runtime-data/events.log`; use a new data directory or task ID when repeating the example. This lifecycle demo requires no model, credentials, or fixture setup.

### Run with a model provider

When an AGY provider binary is configured (Google Antigravity command-line client, used to call Gemini models), connect a queued task to the agent loop:

```bash
# Use a fresh task: demo-task above was cancelled.
cargo run --locked -- enqueue ./runtime-data coding-task

AGENT_TASK="make the failing test pass" \
AGENT_ALLOWED="cargo" \
AGENT_VERIFY="cargo test" \
AGENT_VERIFY="cargo;test;--locked" \
AGY_BIN=/path/to/agy \
cargo run --locked -- run ./runtime-data demo-task ./fixture
cargo run --locked -- run ./runtime-data coding-task ./tests/fixtures/off-by-one
```

The environment-variable example uses a POSIX shell (Bash or zsh). Set `AGY_BIN` to your installed, authenticated provider executable. `AGENT_VERIFY` separates the program and each argument with semicolons, not spaces. The bundled workspace contains a deliberately failing test; this optional run can edit its source. The offline lifecycle demo above does not need this provider setup.

The terminal interface supports `enqueue`, `run`, `cancel`, `status`, and `watch`. Status views replay the event log read-only without triggering recovery side effects.

## Architecture
Expand Down
Loading