@accord-dev/accord 0.3.0 → 0.4.0
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 +13 -13
- package/dist/cli.js +5752 -2325
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ Accord adds a small, fixed folder to your repository. Before an agent writes cod
|
|
|
8
8
|
|
|
9
9
|
BA, designer, developer and reviewer are four stages a ticket passes through, not four job titles. One person can pass through all four, or four people on a team can divide them. No gate reads who anyone is, so the same rules hold either way.
|
|
10
10
|
|
|
11
|
-
Released: `@accord-dev/accord@0.
|
|
11
|
+
Released: `@accord-dev/accord@0.4.0` on npm. See [docs/design.md](https://github.com/ngothanhluan/accord/blob/main/docs/design.md) for the design and the reasoning behind it.
|
|
12
12
|
|
|
13
13
|
## The problem
|
|
14
14
|
|
|
@@ -37,13 +37,13 @@ AI coding agents produce features that pass their own tests and still miss what
|
|
|
37
37
|
Node 22.12 or newer. Run accord through npx with an exact version, so nothing needs installing:
|
|
38
38
|
|
|
39
39
|
```sh
|
|
40
|
-
npx --yes @accord-dev/accord@0.
|
|
40
|
+
npx --yes @accord-dev/accord@0.4.0 <command>
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
Or install it globally and run `accord <command>`:
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
|
-
npm i -g @accord-dev/accord@0.
|
|
46
|
+
npm i -g @accord-dev/accord@0.4.0
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
The global install must be the same version the repository pins (see [Version pin](#7-version-pin-and-upgrading)).
|
|
@@ -53,7 +53,7 @@ The global install must be the same version the repository pins (see [Version pi
|
|
|
53
53
|
In the repository root:
|
|
54
54
|
|
|
55
55
|
```sh
|
|
56
|
-
npx --yes @accord-dev/accord@0.
|
|
56
|
+
npx --yes @accord-dev/accord@0.4.0 init
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
`init` asks nothing and takes no options. It never overwrites `accord/config.yml`, the product files or the workflow when they exist. The skill, agent and pane copies are accord's own and are rewritten to this version, and the hooks are merged into existing settings. Each path is printed as `created`, `skipped`, `appended`, `updated`, `unchanged` or `overwrote local edits`. It writes:
|
|
@@ -76,7 +76,7 @@ git commit -m "accord init"
|
|
|
76
76
|
git push
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
Teammates get the same skills, hooks and pane by pulling. The skills run a bare `accord` command. In Claude Code, the session hook tells the agent to run it through `npx` at the pinned version when `accord` is not on PATH. In Codex, Cursor and Copilot there is no such hook, so each person installs the pinned version globally (`npm i -g @accord-dev/accord@0.
|
|
79
|
+
Teammates get the same skills, hooks and pane by pulling. The skills run a bare `accord` command. In Claude Code, the session hook tells the agent to run it through `npx` at the pinned version when `accord` is not on PATH. In Codex, Cursor and Copilot there is no such hook, so each person installs the pinned version globally (`npm i -g @accord-dev/accord@0.4.0`).
|
|
80
80
|
|
|
81
81
|
### 4. Daily use in your coding agent
|
|
82
82
|
|
|
@@ -95,7 +95,7 @@ Lanes:
|
|
|
95
95
|
- S, a small fix (a bug, a copy change, one flag). The session writes one line for what it understood and one for when it is done, makes the change, runs the affected tests, and runs review rounds with a fresh reviewer until no Must finding is open. Then `gate done` and a pull request.
|
|
96
96
|
- M, a feature (one story). It passes through six stages, each a skill you can also call directly:
|
|
97
97
|
1. intent (`accord-intent`): an interview that writes the intent, acceptance criteria, vetoes and decisions.
|
|
98
|
-
2. approach (`accord-approach`): the lightest approach that works,
|
|
98
|
+
2. approach (`accord-approach`): the planner drafts the lightest approach that works, a critic argues against it in rounds `accord round <id> --approach` counts, and the owner approves it.
|
|
99
99
|
3. plan (`accord-plan`): a task-by-task plan checked by `accord gate plan`.
|
|
100
100
|
4. build (`accord-build`): one fresh executor per task, each recorded with `accord task-done`.
|
|
101
101
|
5. review (`accord-review`): reviewers until no Must is open and every Should is fixed.
|
|
@@ -104,7 +104,7 @@ Lanes:
|
|
|
104
104
|
`accord-debug` finds a root cause before any fix when something fails for a reason nobody has shown.
|
|
105
105
|
- L (an epic) and P (a project) are not built yet. Accord proposes splitting such work into lane M tickets linked by `depends_on`.
|
|
106
106
|
|
|
107
|
-
A request moves from S to M when it changes a public interface or schema, touches a listed sensitive area or auth, money or data deletion, has more than one plausible reading that one question cannot settle, or is expected to touch more than 5 files or more than 3 code areas, tests and generated copies not counted. A scout reads the code before any lane is proposed, a lane S ticket records the files it expects to touch, and `accord gate done` fails it when it touches others. A lane only rises.
|
|
107
|
+
A request moves from S to M when it changes a public interface or schema, touches a listed sensitive area or auth, money or data deletion, has more than one plausible reading that one question cannot settle, or is expected to touch more than 5 files or more than 3 code areas, tests and generated copies not counted. A scout reads the code before any lane is proposed, a lane S ticket records the files it expects to touch, and `accord gate done` fails it when it touches others. A lane only rises, except that a lane M ticket whose intent is not yet approved may move to lane S in place, keeping its id, branch and worktree.
|
|
108
108
|
|
|
109
109
|
Each ticket is worked in its own git worktree, the sibling folder `<repository folder>-<id in lower case>`, prepared by the `setup` commands listed in `config.yml`. `accord worktree open <id>` prints the folder and the `/accord continue <id>` line to type in a session opened there. Tickets done on the remote main branch have their worktree and branches removed by `accord worktree clean`, which `/accord` runs.
|
|
110
110
|
|
|
@@ -117,14 +117,14 @@ In Claude Code, the pane shows the dashboard beside the chat.
|
|
|
117
117
|
After you change `runtimes:`, write the copies again and commit what it prints:
|
|
118
118
|
|
|
119
119
|
```sh
|
|
120
|
-
npx --yes @accord-dev/accord@0.
|
|
120
|
+
npx --yes @accord-dev/accord@0.4.0 skills sync
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
`skills sync`
|
|
123
|
+
`skills sync` deletes no copy you may still use. When you remove a runtime, it lists the copies it no longer writes, and you delete them yourself. The one file it deletes is `.claude/agents/accord-architect.md`, an agent accord no longer has, and only while its marker shows nobody edited it: it prints `removed` for it, and lists an edited copy with the others.
|
|
124
124
|
|
|
125
125
|
### 6. CLI commands for people and CI
|
|
126
126
|
|
|
127
|
-
The skills call the CLI for you. These are the commands most useful to run by hand or in CI. Bare `accord` needs the global install at the pinned version; without it, put `npx --yes @accord-dev/accord@0.
|
|
127
|
+
The skills call the CLI for you. These are the commands most useful to run by hand or in CI. Bare `accord` needs the global install at the pinned version; without it, put `npx --yes @accord-dev/accord@0.4.0` in place of `accord`. Run `accord --help` for the full list, and `accord <command> --help` for each one.
|
|
128
128
|
|
|
129
129
|
| Command | What it does |
|
|
130
130
|
|---|---|
|
|
@@ -142,15 +142,15 @@ The skills call the CLI for you. These are the commands most useful to run by ha
|
|
|
142
142
|
|
|
143
143
|
### 7. Version pin and upgrading
|
|
144
144
|
|
|
145
|
-
`accord/config.yml` pins an exact version in its `accord:` key, and the CI workflow and Claude Code hooks use the same one. Every command that reads the repository refuses with exit 2 when the running version differs (on a version mismatch the `prompt-expansion`
|
|
145
|
+
`accord/config.yml` pins an exact version in its `accord:` key, and the CI workflow and Claude Code hooks use the same one. Every command that reads the repository refuses with exit 2 when the running version differs (on a version mismatch the `prompt-expansion` and `pre-tool-use` hooks only warn, so the prompt or the agent dispatch goes on), and names the command to run instead, with the pinned version in place of 0.4.0:
|
|
146
146
|
|
|
147
147
|
```sh
|
|
148
|
-
npx --yes @accord-dev/accord@0.
|
|
148
|
+
npx --yes @accord-dev/accord@0.4.0 <command>
|
|
149
149
|
```
|
|
150
150
|
|
|
151
151
|
There is no flag or environment variable that skips the check. Only `--version`, `--help` and `upgrade` run regardless.
|
|
152
152
|
|
|
153
|
-
`/accord` says when a newer release is out. `/accord upgrade` runs `upgrade` as the newer version, which pushes a branch `upgrade/<version>` from the remote default branch with one commit that moves the pin and regenerates the skill files. Your checkout is not touched; merge the pull request to upgrade. A repository still pinned to 0.1.0 runs `npx --yes @accord-dev/accord@0.
|
|
153
|
+
`/accord` says when a newer release is out. `/accord upgrade` runs `upgrade` as the newer version, which pushes a branch `upgrade/<version>` from the remote default branch with one commit that moves the pin and regenerates the skill files. Your checkout is not touched; merge the pull request to upgrade. A repository still pinned to 0.1.0 runs `npx --yes @accord-dev/accord@0.4.0 upgrade` once by hand.
|
|
154
154
|
|
|
155
155
|
Exit codes:
|
|
156
156
|
|