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
docs: replace em dashes and move previous version section higher
Replace all em dashes with regular dashes in README. Move the
"Previous Version" section to right before Quickstart so existing
users find it immediately.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@
6
6
7
7
The first open-source harness builder for AI coding. Make AI coding deterministic and repeatable.
8
8
9
-
Archon is a workflow engine for AI coding agents. Define your development processes as YAML workflows — planning, implementation, validation, code review, PR creation — and run them reliably across all your projects.
9
+
Archon is a workflow engine for AI coding agents. Define your development processes as YAML workflows - planning, implementation, validation, code review, PR creation - and run them reliably across all your projects.
10
10
11
-
Like what Dockerfiles did for infrastructure and GitHub Actions did for CI/CD — Archon does for AI coding workflows. Think n8n, but for software development.
11
+
Like what Dockerfiles did for infrastructure and GitHub Actions did for CI/CD - Archon does for AI coding workflows. Think n8n, but for software development.
12
12
13
13
## Install
14
14
@@ -40,11 +40,11 @@ When you ask an AI agent to "fix this bug", what happens depends on the model's
40
40
41
41
Archon fixes this. Encode your development process as a workflow. The workflow defines the phases, validation gates, and artifacts. The AI fills in the intelligence at each step, but the structure is deterministic and owned by you.
42
42
43
-
-**Repeatable**— Same workflow, same sequence, every time. Plan, implement, validate, review, PR.
44
-
-**Isolated**— Every workflow run gets its own git worktree. Run 5 fixes in parallel with no conflicts.
45
-
-**Fire and forget**— Kick off a workflow, go do other work. Come back to a finished PR with review comments.
46
-
-**Composable**— Mix deterministic nodes (bash scripts, tests, git ops) with AI nodes (planning, code generation, review). The AI only runs where it adds value.
47
-
-**Portable**— Define workflows once in `.archon/workflows/`, commit them to your repo. They work the same from CLI, Web UI, Slack, Telegram, or GitHub.
43
+
-**Repeatable**- Same workflow, same sequence, every time. Plan, implement, validate, review, PR.
44
+
-**Isolated**- Every workflow run gets its own git worktree. Run 5 fixes in parallel with no conflicts.
45
+
-**Fire and forget**- Kick off a workflow, go do other work. Come back to a finished PR with review comments.
46
+
-**Composable**- Mix deterministic nodes (bash scripts, tests, git ops) with AI nodes (planning, code generation, review). The AI only runs where it adds value.
47
+
-**Portable**- Define workflows once in `.archon/workflows/`, commit them to your repo. They work the same from CLI, Web UI, Slack, Telegram, or GitHub.
48
48
49
49
## What It Looks Like
50
50
@@ -88,12 +88,16 @@ archon workflow run archon-idea-to-pr --branch feat/dark-mode "Add dark mode to
88
88
# → Result: PR ready for human review
89
89
```
90
90
91
+
## Previous Version
92
+
93
+
Looking for the original Python-based Archon (task management + RAG)? It's fully preserved on the [`archive/v1-task-management-rag`](https://github.com/coleam00/Archon/tree/archive/v1-task-management-rag) branch.
94
+
91
95
## Quickstart
92
96
93
97
<details>
94
-
<summary><b>Prerequisites</b> — Node.js, Claude Code, and the GitHub CLI</summary>
98
+
<summary><b>Prerequisites</b> - Node.js, Claude Code, and the GitHub CLI</summary>
Only needed for E2E/UI testing workflows (`archon-validate-pr`). Core functionality works without it.
133
137
@@ -183,21 +187,21 @@ The coding agent handles workflow selection, branch naming, and worktree isolati
183
187
184
188
### Alternative setup paths
185
189
186
-
-**[Getting Started](https://archon.diy/getting-started/overview/)**— Full setup guide (Web UI or CLI)
190
+
-**[Getting Started](https://archon.diy/getting-started/overview/)**- Full setup guide (Web UI or CLI)
187
191
188
192
## Web UI
189
193
190
194
Archon includes a web dashboard for chatting with your coding agent, running workflows, and monitoring activity. To start it, ask your coding agent to run the frontend from the Archon repo, or run `bun run dev` from the repo root yourself.
191
195
192
-
Register a project by clicking **+** next to "Project" in the chat sidebar — enter a GitHub URL or local path. Then start a conversation, invoke workflows, and watch progress in real time.
196
+
Register a project by clicking **+** next to "Project" in the chat sidebar - enter a GitHub URL or local path. Then start a conversation, invoke workflows, and watch progress in real time.
193
197
194
198
**Key pages:**
195
-
-**Chat**— Conversation interface with real-time streaming and tool call visualization
196
-
-**Dashboard**— Mission Control for monitoring running workflows, with filterable history by project, status, and date
197
-
-**Workflow Builder**— Visual drag-and-drop editor for creating DAG workflows with loop nodes
198
-
-**Workflow Execution**— Step-by-step progress view for any running or completed workflow
199
+
-**Chat**- Conversation interface with real-time streaming and tool call visualization
200
+
-**Dashboard**- Mission Control for monitoring running workflows, with filterable history by project, status, and date
201
+
-**Workflow Builder**- Visual drag-and-drop editor for creating DAG workflows with loop nodes
202
+
-**Workflow Execution**- Step-by-step progress view for any running or completed workflow
199
203
200
-
**Monitoring hub:** The sidebar shows conversations from **all platforms**— not just the web. Workflows kicked off from the CLI, messages from Slack or Telegram, GitHub issue interactions — everything appears in one place.
204
+
**Monitoring hub:** The sidebar shows conversations from **all platforms**- not just the web. Workflows kicked off from the CLI, messages from Slack or Telegram, GitHub issue interactions - everything appears in one place.
201
205
202
206
See the [Web UI Guide](https://archon.diy/adapters/web/) for full documentation.
203
207
@@ -207,7 +211,7 @@ Archon ships with workflows for common development tasks:
207
211
208
212
| Workflow | What it does |
209
213
|----------|-------------|
210
-
|`archon-assist`| General Q&A, debugging, exploration — full Claude Code agent with all tools |
214
+
|`archon-assist`| General Q&A, debugging, exploration - full Claude Code agent with all tools |
@@ -220,14 +224,14 @@ Archon ships with workflows for common development tasks:
220
224
|`archon-feature-development`| Implement feature from plan → validate → create PR |
221
225
|`archon-architect`| Architectural sweep, complexity reduction, codebase health improvement |
222
226
|`archon-refactor-safely`| Safe refactoring with type-check hooks and behavior verification |
223
-
|`archon-ralph-dag`| PRD implementation loop — iterate through stories until done |
227
+
|`archon-ralph-dag`| PRD implementation loop - iterate through stories until done |
224
228
|`archon-remotion-generate`| Generate or modify Remotion video compositions with AI |
225
-
|`archon-test-loop-dag`| Loop node test workflow — iterative counter until completion |
229
+
|`archon-test-loop-dag`| Loop node test workflow - iterative counter until completion |
226
230
|`archon-piv-loop`| Guided Plan-Implement-Validate loop with human review between iterations |
227
231
228
-
Archon ships 17 default workflows — run `archon workflow list` or describe what you want and the router picks the right one.
232
+
Archon ships 17 default workflows - run `archon workflow list` or describe what you want and the router picks the right one.
229
233
230
-
**Or define your own.** Default workflows are great starting points — copy one from `.archon/workflows/defaults/` and customize it. Workflows are YAML files in `.archon/workflows/`, commands are markdown files in `.archon/commands/`. Same-named files in your repo override the bundled defaults. Commit them — your whole team runs the same process.
234
+
**Or define your own.** Default workflows are great starting points - copy one from `.archon/workflows/defaults/` and customize it. Workflows are YAML files in `.archon/workflows/`, commands are markdown files in `.archon/commands/`. Same-named files in your repo override the bundled defaults. Commit them - your whole team runs the same process.
231
235
232
236
See [Authoring Workflows](https://archon.diy/guides/authoring-workflows/) and [Authoring Commands](https://archon.diy/guides/authoring-commands/).
233
237
@@ -298,10 +302,6 @@ Contributions welcome! See the open [issues](https://github.com/coleam00/Archon/
298
302
299
303
Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request.
300
304
301
-
## Previous Version
302
-
303
-
Looking for the original Python-based Archon (task management + RAG)? It's fully preserved on the [`archive/v1-task-management-rag`](https://github.com/coleam00/Archon/tree/archive/v1-task-management-rag) branch.
0 commit comments