Skip to content

Commit 0062d45

Browse files
docs: move getting started to top of README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent afd8078 commit 0062d45

1 file changed

Lines changed: 60 additions & 52 deletions

File tree

README.md

Lines changed: 60 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,73 @@ Relay connects to your existing project management tools, picks up tasks, and us
88

99
No API keys to manage. No per-token billing. No workflow files to write. Relay runs locally on your machine using your Claude Code subscription (Pro, Max, or Team) and plugs directly into the tools you already use.
1010

11-
### Why Relay?
11+
---
1212

13-
- **Works with your Claude Code plan** — uses the `claude` CLI you already have. No separate API keys, no surprise bills
14-
- **Connects to what you use** — Asana, Linear, Jira, and Sentry out of the box. Not just one tracker
15-
- **Fully local** — runs on your machine, against your repos, with your credentials. Nothing leaves your environment
16-
- **Zero config overhead** — point it at a project board and go. No spec files, no workflow DSLs, no Elixir runtime
17-
- **Human in the loop** — every task is triaged, then confirmed before work starts, then approved before anything ships. You stay in control
18-
- **Real-time visibility** — a full React dashboard with live streaming progress, diffs, triage results, and action buttons
13+
## Get started in 2 minutes
14+
15+
**Prerequisites:** [Bun](https://bun.sh) · [Claude Code](https://docs.anthropic.com/en/docs/claude-code) · [GitHub CLI](https://cli.github.com) (`gh auth login`)
16+
17+
```sh
18+
bunx @adriandmitroca/relay
19+
```
20+
21+
Your browser opens at `localhost:7842/setup`. The setup wizard walks you through connecting your first integration (Asana, Linear, Jira, or Sentry) and pointing Relay at a repo. Done.
1922

20-
### How it works
23+
After setup, Relay polls your board, triages tasks with Claude, and waits for your go-ahead before touching any code.
24+
25+
### The full loop
2126

2227
```
2328
Your backlog (Asana / Linear / Jira / Sentry)
2429
→ Relay picks up new tasks
2530
→ Claude triages: is this actionable?
2631
→ You confirm: "Start this one"
2732
→ Claude implements in an isolated worktree
28-
→ You review the diff
29-
→ Accept → branch pushed + PR created
30-
→ Discard → worktree removed
33+
→ You review the diff in the dashboard
34+
→ Accept → branch pushed, PR created
35+
→ Discard → worktree removed, nothing changes
3136
→ Skip → task ignored
3237
```
3338

39+
### Install globally
40+
41+
```sh
42+
bun install -g @adriandmitroca/relay
43+
# or
44+
npm install -g @adriandmitroca/relay
45+
```
46+
47+
### Run as a background service (macOS)
48+
49+
Install once, runs forever — auto-starts on login, restarts on crash.
50+
51+
```sh
52+
bash scripts/install-service.sh
53+
54+
# To remove:
55+
bash scripts/uninstall-service.sh
56+
```
57+
58+
### CLI
59+
60+
```
61+
relay start Start the daemon and open the dashboard
62+
relay stop Stop the daemon
63+
relay update Update to the latest version
64+
relay doctor Check your setup for problems
65+
relay version Show version
66+
```
67+
68+
---
69+
70+
## Why Relay?
71+
72+
- **Works with your Claude Code plan** — uses the `claude` CLI you already have. No separate API keys, no surprise bills
73+
- **Connects to what you use** — Asana, Linear, Jira, and Sentry out of the box
74+
- **Fully local** — runs on your machine, against your repos, with your credentials. Nothing leaves your environment
75+
- **Human in the loop** — every task is triaged, confirmed before work starts, and approved before anything ships
76+
- **Real-time visibility** — live dashboard with streaming progress, diffs, triage results, and one-click actions
77+
3478
## Features
3579

3680
### Integrations
@@ -60,55 +104,19 @@ Optional Telegram integration with forum topics — each task gets its own threa
60104

61105
### Smart Pipeline
62106

63-
- **Triage first** — Claude reads the codebase and decides if a task is actionable before spending time on it. Skip triage if you prefer
107+
- **Triage first** — Claude reads the codebase and decides if a task is actionable before spending time on it
64108
- **Priority queue** — critical issues are handled first. Queue pauses while awaiting your approval
65109
- **Isolated worktrees** — every fix runs in its own git worktree. Your working tree is never touched
66-
- **Session continuity** — triage context carries over to implementation, so Claude doesn't re-read the entire codebase twice
67-
- **Auto-commit** — tests committed separately from code changes for clean PR history
68-
69-
## Getting Started
70-
71-
### Prerequisites
72-
73-
- [Bun](https://bun.sh) v1.1+
74-
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) CLI (`claude` in PATH)
75-
- [GitHub CLI](https://cli.github.com) (`gh auth login` completed)
76-
77-
### Install
78-
79-
```sh
80-
# Try without installing
81-
bunx @adriandmitroca/relay
82-
83-
# Install globally
84-
bun install -g @adriandmitroca/relay
85-
# or
86-
npm install -g @adriandmitroca/relay
87-
```
88-
89-
Your browser opens to `localhost:7842/setup`. Connect your integrations, point Relay at a project, and you're live.
90-
91-
### Run as a background service (macOS)
92-
93-
```sh
94-
bash scripts/install-service.sh # auto-starts on login, restarts on crash
95-
bash scripts/uninstall-service.sh # stop and remove
96-
```
110+
- **Session continuity** — triage context carries over to implementation, so Claude doesn't re-read the codebase twice
111+
- **Auto-commit** — tests committed separately from code changes for a clean PR history
97112

98-
### CLI
99-
100-
```
101-
relay start Start the daemon (opens dashboard)
102-
relay stop Stop the daemon
103-
relay update Update to the latest version
104-
relay version Show version
105-
```
113+
---
106114

107115
## Development
108116

109117
```sh
110118
bun run dev # daemon + Vite dev server with HMR on :5173
111-
bun test # 172 tests across 12 files
119+
bun test # run the test suite
112120
```
113121

114122
### Adding a new source integration

0 commit comments

Comments
 (0)