sidecar-cli 0.1.0-beta.8 → 0.1.0-rc.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 +24 -0
- 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+
|
|
@@ -167,6 +181,16 @@ Agents can discover the CLI surface programmatically with:
|
|
|
167
181
|
sidecar capabilities --json
|
|
168
182
|
```
|
|
169
183
|
|
|
184
|
+
## Repo policy
|
|
185
|
+
|
|
186
|
+
When changes are made in this repo, document them in Sidecar:
|
|
187
|
+
|
|
188
|
+
1. `sidecar context --format markdown`
|
|
189
|
+
2. `sidecar worklog record --done "<what changed>" --files <paths> --by human|agent`
|
|
190
|
+
3. `sidecar decision record ...` when behavior/design changes
|
|
191
|
+
4. `sidecar task add ...` for follow-up work
|
|
192
|
+
5. `sidecar summary refresh`
|
|
193
|
+
|
|
170
194
|
## Local storage details
|
|
171
195
|
|
|
172
196
|
All data is local in `.sidecar/sidecar.db` (SQLite).
|