Skip to content

Commit bcd8459

Browse files
coleam00claude
andcommitted
docs: unify getting started flow and improve What It Looks Like intro
- Shared "Start Using Archon" section after both setup paths - Remove duplicated usage instructions from each path - Full Setup ends at the wizard, Quick Install ends at the binary - Both converge to "go to your project, open Claude Code, start working" - Better intro line for the workflow example Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 0298070 commit bcd8459

1 file changed

Lines changed: 18 additions & 31 deletions

File tree

README.md

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Archon fixes this. Encode your development process as a workflow. The workflow d
3838

3939
## What It Looks Like
4040

41-
A workflow that plans, implements in a loop until tests pass, gets your approval, then creates the PR:
41+
Here's an example of an Archon workflow that plans, implements in a loop until tests pass, gets your approval, then creates the PR:
4242

4343
```yaml
4444
# .archon/workflows/build-feature.yaml
@@ -152,35 +152,9 @@ Then say: **"Set up Archon"**
152152

153153
The setup wizard walks you through everything: CLI installation, authentication, platform selection, and copies the Archon skill to your target repo.
154154

155-
Once setup is complete:
156-
157-
```bash
158-
# 1. Exit Claude Code in the Archon repo (Ctrl+C or /exit)
159-
160-
# 2. Go to your project
161-
cd /path/to/your/project
162-
163-
# 3. Open Claude Code from your project
164-
claude
165-
```
166-
167-
Then start working:
168-
169-
```
170-
Use archon to fix issue #42
171-
```
172-
173-
```
174-
What archon workflows do I have? When would I use each one?
175-
```
176-
177-
The coding agent handles workflow selection, branch naming, and worktree isolation for you. Projects are registered automatically the first time they're used.
178-
179-
> **Important:** Always run Claude Code from your target repo, not from the Archon repo. The setup wizard copies the Archon skill into your project so it works from there.
180-
181155
### Quick Install (30 seconds)
182156

183-
Install the standalone CLI binary if you just want to run workflows from the terminal.
157+
Already have Claude Code set up? Install the standalone CLI binary and skip the wizard.
184158

185159
**macOS / Linux**
186160
```bash
@@ -197,14 +171,27 @@ irm https://archon.diy/install.ps1 | iex
197171
brew install coleam00/archon/archon
198172
```
199173

200-
Then go to any git repo and start running workflows:
174+
### Start Using Archon
175+
176+
Once you've completed either setup path, go to your project and start working:
201177

202178
```bash
203179
cd /path/to/your/project
204-
archon workflow list
205-
archon workflow run archon-assist "What does this codebase do?"
180+
claude
181+
```
182+
183+
```
184+
Use archon to fix issue #42
206185
```
207186
187+
```
188+
What archon workflows do I have? When would I use each one?
189+
```
190+
191+
The coding agent handles workflow selection, branch naming, and worktree isolation for you. Projects are registered automatically the first time they're used.
192+
193+
> **Important:** Always run Claude Code from your target repo, not from the Archon repo. The setup wizard copies the Archon skill into your project so it works from there.
194+
208195
## Web UI
209196
210197
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.

0 commit comments

Comments
 (0)