@straiffi/archon 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -51,21 +51,25 @@ Required or commonly expected tools:
|
|
|
51
51
|
| Tool | Why it matters |
|
|
52
52
|
| --- | --- |
|
|
53
53
|
| `git` | Required for project repositories, worktrees, diffing, and commit operations |
|
|
54
|
-
| `opencode` |
|
|
55
|
-
| `claude` |
|
|
56
|
-
| `gh` |
|
|
54
|
+
| `opencode` | Needed for OpenCode-backed plan, build, chat, and review workflows |
|
|
55
|
+
| `claude` | Needed for Claude-backed workflows |
|
|
56
|
+
| `gh` | Optional for GitHub PR and review workflows; GitHub API key integration also works without it |
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
Archon should still start if an optional tool is missing, but features that depend on that binary or integration path will return actionable errors.
|
|
59
59
|
|
|
60
60
|
## How It Works
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
Archon has three main workspaces:
|
|
63
63
|
|
|
64
|
-
1. **
|
|
65
|
-
2. **
|
|
66
|
-
3. **
|
|
64
|
+
1. **Board**: create tickets, move them through planning and implementation, and run builds in isolated git worktrees on dedicated branches.
|
|
65
|
+
2. **Chat**: use persistent project chat sessions for planning, implementation help, and follow-up questions. Chat supports both planning-oriented and build-oriented turns so you can scope work first, then continue in the same conversation.
|
|
66
|
+
3. **Memory**: optionally save project conventions, accepted decisions, and other prompt context in Archon so future ticket, chat, build, and review runs stay aligned with how your project works.
|
|
67
|
+
|
|
68
|
+
Within the board workflow, tickets move through three stages:
|
|
67
69
|
|
|
68
|
-
|
|
70
|
+
1. **Plan**: write a title and description for the feature or task
|
|
71
|
+
2. **Build**: Archon runs your configured AI tool in a new git worktree and streams progress back to the UI in real time
|
|
72
|
+
3. **Review**: an agent reviews the resulting changes and suggests fixes that you can inspect and accept manually
|
|
69
73
|
|
|
70
74
|
## Project Setup
|
|
71
75
|
|
|
@@ -73,13 +77,13 @@ After Archon starts, create a project from the UI:
|
|
|
73
77
|
|
|
74
78
|
1. Click `Create project`
|
|
75
79
|
2. Enter a project name and repository path
|
|
76
|
-
3. Optionally click `Auto-config` to
|
|
80
|
+
3. Optionally click `Auto-config` to fill any empty setup, service, or worktree sync settings
|
|
77
81
|
4. Optionally open `Advanced settings` to review or edit setup, service, worktree sync, and IDE settings
|
|
78
82
|
5. Save the project, select it in the project switcher, and create tickets inside that project
|
|
79
83
|
|
|
80
84
|
## Project Configuration
|
|
81
85
|
|
|
82
|
-
|
|
86
|
+
Use the project form in the UI to configure how Archon prepares worktrees and runs project-specific services.
|
|
83
87
|
|
|
84
88
|
### Required fields
|
|
85
89
|
|
|
@@ -88,7 +92,7 @@ Archon stores repository and run settings per project in its database. Use the p
|
|
|
88
92
|
| `Project name` | The label shown in the project switcher, such as `Platform API` or `Marketing Site` |
|
|
89
93
|
| `Repository path` | Any path inside the target git repository; Archon resolves it to the repo root before saving |
|
|
90
94
|
|
|
91
|
-
`Auto-config` is available in both the create and edit project modals. It
|
|
95
|
+
`Auto-config` is available in both the create and edit project modals. It fills only empty `Setup commands`, `Services`, and `Worktree sync` sections, and it never changes `IDE command`.
|
|
92
96
|
|
|
93
97
|
### Advanced fields
|
|
94
98
|
|
|
@@ -100,10 +104,6 @@ Archon stores repository and run settings per project in its database. Use the p
|
|
|
100
104
|
| `cwd` | Optional working directory for a service, relative to the worktree root. For example, use `client` for a frontend dev server or `server` for an API process. Leave it blank to run from the worktree root. |
|
|
101
105
|
| `IDE command` | Optional command to open the finished worktree in your editor after services start, such as `code --reuse-window` or `idea`. |
|
|
102
106
|
|
|
103
|
-
Worktree sync entries are stored as `{ source, target?, mode }` objects. `source` is required, `target` is optional and defaults to the same path, and `mode` is either `copy` or `symlink`.
|
|
104
|
-
|
|
105
|
-
Service entries are stored as `{ cmd, cwd }` objects. `cmd` is required, while `cwd` is optional.
|
|
106
|
-
|
|
107
107
|
### Example project setup
|
|
108
108
|
|
|
109
109
|
```text
|