sidecar-cli 0.1.0-beta.8 → 0.1.1-beta.1
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 +36 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -33,6 +33,13 @@ Install rc:
|
|
|
33
33
|
npm install -g sidecar-cli@rc
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
+
Install with Homebrew (stable):
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
brew tap karlhills/sidecar
|
|
40
|
+
brew install sidecar
|
|
41
|
+
```
|
|
42
|
+
|
|
36
43
|
Or run without install:
|
|
37
44
|
|
|
38
45
|
```bash
|
|
@@ -40,6 +47,13 @@ npx sidecar-cli --help
|
|
|
40
47
|
npx sidecar-cli@beta --help
|
|
41
48
|
```
|
|
42
49
|
|
|
50
|
+
Update Homebrew install:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
brew update
|
|
54
|
+
brew upgrade sidecar
|
|
55
|
+
```
|
|
56
|
+
|
|
43
57
|
Requirements:
|
|
44
58
|
|
|
45
59
|
- Node.js 20+
|
|
@@ -154,7 +168,18 @@ Optional local enforcement:
|
|
|
154
168
|
npm run install:hooks
|
|
155
169
|
```
|
|
156
170
|
|
|
157
|
-
This
|
|
171
|
+
This is optional and per-repository clone. `sidecar init` does not install git hooks automatically.
|
|
172
|
+
|
|
173
|
+
This installs a pre-commit guard that checks staged non-doc code changes.
|
|
174
|
+
If staged code changes are present, commit is blocked unless both are recorded since the last commit:
|
|
175
|
+
|
|
176
|
+
- a `worklog` event
|
|
177
|
+
- a `summary refresh` event
|
|
178
|
+
|
|
179
|
+
The guard command is:
|
|
180
|
+
|
|
181
|
+
- `npm run sidecar:reminder -- --staged --enforce`
|
|
182
|
+
|
|
158
183
|
If a pre-commit hook already exists, Sidecar will not overwrite it unless you run:
|
|
159
184
|
|
|
160
185
|
```bash
|
|
@@ -167,6 +192,16 @@ Agents can discover the CLI surface programmatically with:
|
|
|
167
192
|
sidecar capabilities --json
|
|
168
193
|
```
|
|
169
194
|
|
|
195
|
+
## Repo policy
|
|
196
|
+
|
|
197
|
+
When changes are made in this repo, document them in Sidecar:
|
|
198
|
+
|
|
199
|
+
1. `sidecar context --format markdown`
|
|
200
|
+
2. `sidecar worklog record --done "<what changed>" --files <paths> --by human|agent`
|
|
201
|
+
3. `sidecar decision record ...` when behavior/design changes
|
|
202
|
+
4. `sidecar task add ...` for follow-up work
|
|
203
|
+
5. `sidecar summary refresh`
|
|
204
|
+
|
|
170
205
|
## Local storage details
|
|
171
206
|
|
|
172
207
|
All data is local in `.sidecar/sidecar.db` (SQLite).
|