sidecar-cli 0.1.0-beta.7 → 0.1.0-rc.1

package/README.md

@@ -11,15 +11,7 @@ Sidecar is a local-first, CLI-first project memory and recording tool for human
 - Keep project memory structured and local.
 - Make session handoffs easier for humans and agents.
 - Record decisions, work logs, tasks, notes, sessions, and artifacts in one stable CLI.
-- Generate deterministic context and summary outputs without any cloud or LLM dependency.
-
-## v1 scope
-
-- No cloud sync
-- No remote server
-- No GUI
-- No MCP server
-- No passive prompt capture
+- Generate deterministic context and summary outputs from local project data.
 
 ## Install
 
@@ -41,6 +33,13 @@ Install rc:
 npm install -g sidecar-cli@rc
 ```
 
+Install with Homebrew (stable):
+
+```bash
+brew tap karlhills/sidecar
+brew install sidecar
+```
+
 Or run without install:
 
 ```bash
@@ -48,6 +47,13 @@ npx sidecar-cli --help
 npx sidecar-cli@beta --help
 ```
 
+Update Homebrew install:
+
+```bash
+brew update
+brew upgrade sidecar
+```
+
 Requirements:
 
 - Node.js 20+
@@ -76,7 +82,7 @@ npm run dev -- --help
 Initialize in a project directory:
 
 ```bash
-npm run dev -- init
+sidecar init
 ```
 
 This creates:
@@ -86,6 +92,8 @@ This creates:
 - `.sidecar/preferences.json`
 - `.sidecar/AGENTS.md`
 - `.sidecar/summary.md`
+- `AGENTS.md` (repo root)
+- `CLAUDE.md` (repo root)
 
 Use `--force` to overwrite Sidecar-managed files.
 
@@ -173,6 +181,16 @@ Agents can discover the CLI surface programmatically with:
 sidecar capabilities --json
 ```
 
+## Repo policy
+
+When changes are made in this repo, document them in Sidecar:
+
+1. `sidecar context --format markdown`
+2. `sidecar worklog record --done "<what changed>" --files <paths> --by human|agent`
+3. `sidecar decision record ...` when behavior/design changes
+4. `sidecar task add ...` for follow-up work
+5. `sidecar summary refresh`
+
 ## Local storage details
 
 All data is local in `.sidecar/sidecar.db` (SQLite).
@@ -200,49 +218,5 @@ This makes Sidecar easy to automate from scripts and AI agents.
 
 ## Release and distribution
 
-Sidecar uses tag-based GitHub Actions releases.
-
-Tag formats:
-
-- stable: `v1.2.3`
-- beta: `v1.2.3-beta.1`
-- rc: `v1.2.3-rc.1`
-
-Behavior:
-
-- stable tags publish npm `latest`
-- beta tags publish npm `beta`
-- rc tags publish npm `rc`
-- all release tags create GitHub Releases and upload tarball assets
-- Homebrew tap updates are stable-only (beta/rc intentionally skipped)
-
-Workflows:
-
-- CI: `.github/workflows/ci.yml`
-- Release: `.github/workflows/release.yml`
-
-Required configuration:
-
-- `NPM_TOKEN` (secret)
-- `HOMEBREW_TAP_REPO` (variable, optional)
-- `HOMEBREW_TAP_GITHUB_TOKEN` (secret, optional)
-
-See [RELEASE.md](./RELEASE.md) for full release steps and examples.
+See [RELEASE.md](./RELEASE.md) for publishing/release details.
 See [CONTRIBUTING.md](./CONTRIBUTING.md) for code structure and contribution guidelines.
-
-Quick preflight:
-
-```bash
-npm run release_check -- --tag v1.2.3
-```
-
-One-command release:
-
-```bash
-npm run release:stable -- --version 1.2.3
-npm run release:beta -- --version 1.2.3 --pre 1
-npm run release:rc -- --version 1.2.3 --pre 1
-
-# preview only (no commit/tag/push)
-npm run release:beta -- --version 1.2.3 --pre 1 --dry-run
-```

package/dist/cli.js

@@ -12,7 +12,7 @@ import { jsonFailure, jsonSuccess, printJsonEnvelope } from './lib/output.js';
 import { bannerDisabled, renderBanner } from './lib/banner.js';
 import { getUpdateNotice } from './lib/update-check.js';
 import { requireInitialized } from './db/client.js';
-import { renderAgentsMarkdown } from './templates/agents.js';
+import { renderAgentsMarkdown, renderClaudeMarkdown } from './templates/agents.js';
 import { refreshSummaryFile } from './services/summary-service.js';
 import { buildContext } from './services/context-service.js';
 import { getCapabilitiesManifest } from './services/capabilities-service.js';
@@ -216,8 +216,11 @@ program
             sidecar.summaryPath,
         ];
         const shouldWriteRootAgents = Boolean(opts.force) || !fs.existsSync(sidecar.rootAgentsPath);
+        const shouldWriteRootClaude = Boolean(opts.force) || !fs.existsSync(sidecar.rootClaudePath);
         if (shouldWriteRootAgents)
             files.push(sidecar.rootAgentsPath);
+        if (shouldWriteRootClaude)
+            files.push(sidecar.rootClaudePath);
         fs.mkdirSync(sidecar.sidecarPath, { recursive: true });
         if (opts.force) {
             for (const file of [
@@ -254,6 +257,9 @@ program
         if (shouldWriteRootAgents) {
             fs.writeFileSync(sidecar.rootAgentsPath, renderAgentsMarkdown(projectName));
         }
+        if (shouldWriteRootClaude) {
+            fs.writeFileSync(sidecar.rootClaudePath, renderClaudeMarkdown(projectName));
+        }
         const db2 = new Database(sidecar.dbPath);
         const refreshed = refreshSummaryFile(db2, rootPath, 1, 10);
         db2.close();

package/dist/lib/paths.js

@@ -7,6 +7,7 @@ export function getSidecarPaths(rootPath) {
         rootPath,
         sidecarPath,
         rootAgentsPath: path.join(rootPath, 'AGENTS.md'),
+        rootClaudePath: path.join(rootPath, 'CLAUDE.md'),
         dbPath: path.join(sidecarPath, 'sidecar.db'),
         configPath: path.join(sidecarPath, 'config.json'),
         preferencesPath: path.join(sidecarPath, 'preferences.json'),

package/dist/templates/agents.js

@@ -1,6 +1,8 @@
-export function renderAgentsMarkdown(projectName) {
+function renderSharedGuide(projectName, heading) {
     return `# Sidecar Agent Guide
 
+${heading}
+
 Sidecar is the local project memory tool for this repository.
 
 ## MUST before final response
@@ -71,3 +73,9 @@ Run this before final response to catch missed Sidecar logging:
 Project: ${projectName}.
 `;
 }
+export function renderAgentsMarkdown(projectName) {
+    return renderSharedGuide(projectName, 'Use this guide for AI coding agents in this repository.');
+}
+export function renderClaudeMarkdown(projectName) {
+    return renderSharedGuide(projectName, 'Claude-specific note: treat this as required workflow, not advisory context.');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sidecar-cli",
-  "version": "0.1.0-beta.7",
+  "version": "0.1.0-rc.1",
   "description": "Local-first project memory and recording tool",
   "scripts": {
     "build": "npm run clean && tsc -p tsconfig.json",