@accord-dev/accord 0.5.1 → 0.7.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.
Files changed (3) hide show
  1. package/README.md +31 -20
  2. package/dist/cli.js +4088 -1866
  3. 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.5.1` on npm. See [docs/design.md](https://github.com/ngothanhluan/accord/blob/main/docs/design.md) for the design and the reasoning behind it.
11
+ Released: `@accord-dev/accord@0.7.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,23 +37,23 @@ 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.5.1 <command>
40
+ npx --yes @accord-dev/accord@0.7.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.5.1
46
+ npm i -g @accord-dev/accord@0.7.0
47
47
  ```
48
48
 
49
- The global install must be the same version the repository pins (see [Version pin](#7-version-pin-and-upgrading)).
49
+ The global install must be the same version the repository pins (see [Version pin](#8-version-pin-and-upgrading)).
50
50
 
51
51
  ### 2. Initialise a repository
52
52
 
53
53
  In the repository root:
54
54
 
55
55
  ```sh
56
- npx --yes @accord-dev/accord@0.5.1 init
56
+ npx --yes @accord-dev/accord@0.7.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:
@@ -62,7 +62,7 @@ npx --yes @accord-dev/accord@0.5.1 init
62
62
  - `accord/product/glossary.md`, `accord/product/business-rules.md` and `accord/product/conventions.md`, from templates.
63
63
  - `.github/workflows/accord.yml`, a GitHub Actions workflow that runs `lint` and `gate done` on the tickets a pull request changes, with the same pinned version.
64
64
  - The skills: `/accord` and the stage skills `accord-intent` (which holds the discuss stage), `accord-approach`, `accord-plan`, `accord-build`, `accord-review`, `accord-verify` and `accord-debug`, plus `accord-designer` for the `designer` role in `roles:`. Claude Code reads them from `.claude/skills/`, Codex from `.agents/skills/`.
65
- - For Claude Code only: the accord agents in `.claude/agents/`, the dashboard pane plugin in `.claude/accord-panel/`, and in `.claude/settings.json` the session hooks and the keys that enable the pane. Existing settings are kept.
65
+ - For Claude Code only: the accord agents in `.claude/agents/`, the dashboard pane plugin in `.claude/accord-panel/`, and in `.claude/settings.json` the session hooks, one that lets only the `accord-verifier` subagent write `verification.md`, and the keys that enable the pane. Existing settings are kept.
66
66
  - A short accord block appended to `AGENTS.md` and `CLAUDE.md`, or those files created.
67
67
 
68
68
  Then edit `accord/config.yml`. Before the first ticket that carries a `@test:` scenario, remove the `# ` from the commented `tests:` and `report:` lines at its end, and set `report:` to the JUnit report your test runner writes.
@@ -76,9 +76,19 @@ 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.5.1`).
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.7.0`).
80
80
 
81
- ### 4. Daily use in your coding agent
81
+ ### 4. Make the accord check a merge gate
82
+
83
+ accord changes no GitHub setting, so nothing yet stops a pull request from merging when the accord check fails. `accord init` prints these steps; a repository admin does them once on GitHub:
84
+
85
+ 1. Open Settings > Rules > Rulesets and add a branch ruleset that targets the default branch, or open Settings > Branches and add a branch protection rule for it.
86
+ 2. Turn on "Require status checks to pass" and add the check "lint and gate the tickets this pull request touches"; it is listed once the accord workflow has run on a pull request.
87
+ 3. Turn on "Require branches to be up to date before merging", so the suite CI runs on a pull request is the suite of what the merge will hold.
88
+
89
+ `accord-verify` reads these rules with `gh` and says in its report when the check is not required or branches need not be up to date.
90
+
91
+ ### 5. Daily use in your coding agent
82
92
 
83
93
  All work starts from the `/accord` skill inside the agent session:
84
94
 
@@ -88,7 +98,7 @@ All work starts from the `/accord` skill inside the agent session:
88
98
  | `/accord <request>` | New work. Accord proposes a lane with its reason; you may override it. |
89
99
  | `/accord continue <id>` | Resume a ticket at the stage and step it reached. |
90
100
  | `/accord pick-up <id>` | Claim an unclaimed ticket and start it. |
91
- | `/accord upgrade` | Move the repository to a newer accord release (see [Version pin](#7-version-pin-and-upgrading)). |
101
+ | `/accord upgrade` | Move the repository to a newer accord release (see [Version pin](#8-version-pin-and-upgrading)). |
92
102
 
93
103
  Lanes:
94
104
 
@@ -105,27 +115,27 @@ Lanes:
105
115
  - R, research: a question accord cannot answer from the code, with no change asked. `accord new ticket <id> --lane R` writes a ticket with a question, a timebox and a token budget the owner sets, quoted under `## Decisions`. The session researches within them, checks `accord budget <id>` between steps and stops to ask the owner past either, and ends in a record under `accord/research/`, written on its branch after the claim, that the ticket lists under `research:`; an older record listed there is evidence, not the result. There is no approach, plan, critic, review or verification; `accord gate done` refuses a branch that changes the shipped packages.
106
116
  - L (an epic) and P (a project) are not built yet. Accord proposes splitting such work into lane M tickets linked by `depends_on`.
107
117
 
108
- 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; `accord scout check` checks the citations and logged searches of its report and prints the lane numbers, and the report is saved as `accord/tickets/<id>/scout.md`, which `accord approve` requires of a lane M ticket, judged by the same check at the commit that last changed it, unless the file holds a `skipped: <reason>` line. 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.
118
+ A request moves from S to M when it changes a public interface or schema, touches a listed sensitive area or auth, money, migration 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; `accord scout check` checks the citations and logged searches of its report and prints the lane numbers, and the report is saved as `accord/tickets/<id>/scout.md`, which `accord approve` requires of a lane M ticket, judged by the same check at the commit that last changed it, unless the file holds a `skipped: <reason>` line. 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.
109
119
 
110
120
  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.
111
121
 
112
122
  In Claude Code, the pane shows the dashboard beside the chat.
113
123
 
114
- ### 5. Other runtimes
124
+ ### 6. Other runtimes
115
125
 
116
126
  `runtimes:` in `accord/config.yml` decides which skill folders accord writes. `claude` writes `.claude/skills/` and also the agents, the pane and the hooks; `codex` writes `.agents/skills/`. Cursor and Copilot read both folders, so the default `runtimes: [claude, codex]` already serves all four tools, and listing `cursor` or `copilot` adds nothing.
117
127
 
118
128
  After you change `runtimes:`, write the copies again and commit what it prints:
119
129
 
120
130
  ```sh
121
- npx --yes @accord-dev/accord@0.5.1 skills sync
131
+ npx --yes @accord-dev/accord@0.7.0 skills sync
122
132
  ```
123
133
 
124
134
  `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.
125
135
 
126
- ### 6. CLI commands for people and CI
136
+ ### 7. CLI commands for people and CI
127
137
 
128
- 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.5.1` in place of `accord`. Run `accord --help` for the full list, and `accord <command> --help` for each one.
138
+ 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.7.0` in place of `accord`. Run `accord --help` for the full list, and `accord <command> --help` for each one.
129
139
 
130
140
  | Command | What it does |
131
141
  |---|---|
@@ -139,22 +149,23 @@ The skills call the CLI for you. These are the commands most useful to run by ha
139
149
  | `accord scout check <file> [--ticket <id>]` | Check a scout report's citations and logged searches against the files git tracks, and print its lane numbers. `--ticket` leaves that ticket's own files and listed research records out of every search, as for a saved `scout.md`. |
140
150
  | `accord new ticket [id] [--lane <lane>]` | Write `accord/tickets/<id>.md` from the template, or from the lane's template under `--lane` (S, M, L, P, or R for research). |
141
151
  | `accord budget <id>` | Report whether a lane R ticket is within its timebox and token budget since its claim commit (exit 1 means stop and ask the owner), and print the `Spent:` line its research record states. Tokens read `not measured` when the checkout's own transcripts do not cover the time since the claim. |
142
- | `accord trust [<script>@<digest>...] [--revoke]` | With no script named, show each script `accord/config.yml` declares (`tracker.command` under the `script` adapter, and `git.sync`): its command, a digest of what it covers, the files an allow covers and the ones that changed, and allow nothing. `accord trust git.sync@<digest>` or `accord trust tracker.command@<digest>`, with the digest the preview printed, allows that script in this repository, and refuses if the files changed since: a local record inside `.git`, never committed, bound to the command and the files it reaches (the script's whole folder, the package.json script `npm run` runs), so a change to either asks again. accord checks only the files it lists; anything else the command loads is not checked, so whoever allows a script must review the pull request that changed it. `--revoke` withdraws the allows. |
152
+ | `accord trust [<script>@<digest>...] [--revoke]` | With no script named, show each script `accord/config.yml` declares (`tracker.command` under the `script` adapter, `git.sync`, and `build.regenerate`, which `accord worktree task merge` prints for the build stage to run only once it is allowed): its command, a digest of what it covers, the files an allow covers and the ones that changed, and allow nothing. `accord trust git.sync@<digest>` or `accord trust tracker.command@<digest>`, with the digest the preview printed, allows that script in this repository, and refuses if the files changed since: a local record inside `.git`, never committed, bound to the command and the files it reaches (the script's whole folder, the package.json script `npm run` runs), so a change to either asks again. accord checks only the files it lists; anything else the command loads is not checked, so whoever allows a script must review the pull request that changed it. `--revoke` withdraws the allows. |
153
+ | `accord review-package <id> [--base <ref>] [--security [--round <n>]]` | Print the commits, stat and diff a reviewer reads, with the security triggers the diff matched. `--security` prints the security package instead: the checklist, the triggers and only the hunks they match, whole, with their context (a path match is cut at 300 lines, and the cut says how many lines it left out). `--security --round <n>` prints it for the n-th round of `review.md`, over the range `accord round` and `accord gate done` check; a `(final review)` round has none. |
143
154
  | `accord skills sync` | Write every skill the config declares into `.claude/skills/` and `.agents/skills/`. |
144
155
  | `accord worktree open <id>` | Find or prepare the ticket's worktree. |
145
156
  | `accord worktree clean` | Remove worktrees and branches of tickets done on the default branch. |
146
157
 
147
- ### 7. Version pin and upgrading
158
+ ### 8. Version pin and upgrading
148
159
 
149
- `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.5.1:
160
+ `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.7.0:
150
161
 
151
162
  ```sh
152
- npx --yes @accord-dev/accord@0.5.1 <command>
163
+ npx --yes @accord-dev/accord@0.7.0 <command>
153
164
  ```
154
165
 
155
166
  There is no flag or environment variable that skips the check. Only `--version`, `--help` and `upgrade` run regardless.
156
167
 
157
- `/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.5.1 upgrade` once by hand.
168
+ `/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.7.0 upgrade` once by hand.
158
169
 
159
170
  Exit codes:
160
171
 
@@ -164,7 +175,7 @@ Exit codes:
164
175
  | 1 | Gate failed, or lint found errors. The reasons are printed. |
165
176
  | 2 | Usage or environment error: bad arguments, no accord folder, unreadable config, version mismatch. |
166
177
 
167
- ### 8. Running main from a clone
178
+ ### 9. Running main from a clone
168
179
 
169
180
  To work on accord itself:
170
181