sidecar-cli 0.1.0-beta.5 → 0.1.0-beta.6
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 +15 -6
- package/dist/templates/agents.js +11 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -144,14 +144,23 @@ sidecar session end --summary "Initialization and recording flow implemented"
|
|
|
144
144
|
## AI agent usage
|
|
145
145
|
|
|
146
146
|
Sidecar generates `.sidecar/AGENTS.md` during `init`.
|
|
147
|
+
This repo also includes a root `AGENTS.md` so the policy is visible before any `.sidecar` lookup.
|
|
147
148
|
|
|
148
|
-
|
|
149
|
+
Required minimum for any code change:
|
|
149
150
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
-
|
|
154
|
-
|
|
151
|
+
1. `sidecar context --format markdown`
|
|
152
|
+
2. `sidecar worklog record --done "<what changed>" --files <paths> --by agent`
|
|
153
|
+
3. if behavior/design changed: `sidecar decision record ...`
|
|
154
|
+
4. if follow-up exists: `sidecar task add ...`
|
|
155
|
+
5. `sidecar summary refresh`
|
|
156
|
+
|
|
157
|
+
Optional local enforcement:
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
npm run install:hooks
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
This installs a non-blocking pre-commit reminder that runs `npm run sidecar:reminder`.
|
|
155
164
|
|
|
156
165
|
Agents can discover the CLI surface programmatically with:
|
|
157
166
|
|
package/dist/templates/agents.js
CHANGED
|
@@ -3,6 +3,16 @@ export function renderAgentsMarkdown(projectName) {
|
|
|
3
3
|
|
|
4
4
|
Sidecar is the local project memory tool for this repository.
|
|
5
5
|
|
|
6
|
+
## MUST before final response
|
|
7
|
+
|
|
8
|
+
If you changed code, you MUST run these commands in order:
|
|
9
|
+
|
|
10
|
+
1. \`sidecar context --format markdown\`
|
|
11
|
+
2. \`sidecar worklog record --done "<what changed>" --files <paths> --by agent\`
|
|
12
|
+
3. if behavior/design/architecture changed: \`sidecar decision record --title "<decision>" --summary "<why>" --by agent\`
|
|
13
|
+
4. if follow-up exists: \`sidecar task add "<follow-up>" --priority medium --by agent\`
|
|
14
|
+
5. \`sidecar summary refresh\`
|
|
15
|
+
|
|
6
16
|
## Required workflow
|
|
7
17
|
|
|
8
18
|
For any code change, run these in order before final response:
|
|
@@ -18,6 +28,7 @@ For any code change, run these in order before final response:
|
|
|
18
28
|
- If files changed: always record a worklog.
|
|
19
29
|
- If behavior/design choice changed: record a decision.
|
|
20
30
|
- If follow-up work exists: add a task.
|
|
31
|
+
- Never skip summary refresh after recording work.
|
|
21
32
|
|
|
22
33
|
## Definition of Done
|
|
23
34
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sidecar-cli",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.6",
|
|
4
4
|
"description": "Local-first project memory and recording tool",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "npm run clean && tsc -p tsconfig.json",
|
|
@@ -14,7 +14,8 @@
|
|
|
14
14
|
"release:stable": "node scripts/cut-release.mjs --channel stable",
|
|
15
15
|
"release:beta": "node scripts/cut-release.mjs --channel beta",
|
|
16
16
|
"release:rc": "node scripts/cut-release.mjs --channel rc",
|
|
17
|
-
"sidecar:reminder": "node scripts/sidecar-reminder.mjs"
|
|
17
|
+
"sidecar:reminder": "node scripts/sidecar-reminder.mjs",
|
|
18
|
+
"install:hooks": "node scripts/install-git-hooks.mjs"
|
|
18
19
|
},
|
|
19
20
|
"keywords": [],
|
|
20
21
|
"author": "",
|