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
Copy file name to clipboardExpand all lines: README.md
+60-52Lines changed: 60 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,29 +8,73 @@ Relay connects to your existing project management tools, picks up tasks, and us
8
8
9
9
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.
10
10
11
-
### Why Relay?
11
+
---
12
12
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
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.
19
22
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
21
26
22
27
```
23
28
Your backlog (Asana / Linear / Jira / Sentry)
24
29
→ Relay picks up new tasks
25
30
→ Claude triages: is this actionable?
26
31
→ You confirm: "Start this one"
27
32
→ 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
31
36
→ Skip → task ignored
32
37
```
33
38
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
+
34
78
## Features
35
79
36
80
### Integrations
@@ -60,55 +104,19 @@ Optional Telegram integration with forum topics — each task gets its own threa
60
104
61
105
### Smart Pipeline
62
106
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
64
108
-**Priority queue** — critical issues are handled first. Queue pauses while awaiting your approval
65
109
-**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)
0 commit comments