@rely-ai/caliber 1.35.1 → 1.37.0-dev.1774891449

package/README.md

@@ -1,3 +1,7 @@
+# Caliber
+
+**Hand-written `CLAUDE.md` files go stale the moment you refactor.** Your AI agent hallucinates paths that no longer exist, misses new dependencies, and gives advice based on yesterday's architecture. Caliber generates and maintains your AI context files (`CLAUDE.md`, `.cursor/rules/`, `AGENTS.md`) so they stay accurate as your code evolves — and keeps every agent on your team in sync, whether they use Claude Code, Cursor, Codex, or OpenCode.
+
 <p align="center">
   <img src="assets/demo-header.gif" alt="Caliber product demo" width="900">
 </p>
@@ -10,30 +14,15 @@
   <img src="https://img.shields.io/badge/Claude_Code-supported-blue" alt="Claude Code">
   <img src="https://img.shields.io/badge/Cursor-supported-blue" alt="Cursor">
   <img src="https://img.shields.io/badge/Codex-supported-blue" alt="Codex">
+  <img src="https://img.shields.io/badge/OpenCode-supported-blue" alt="OpenCode">
 </p>
 
----
-
-### Try it — zero install, zero commitment
-
-```bash
-npx @rely-ai/caliber score
-```
-
-Score your AI agent config in 3 seconds. No API key. No changes to your code. Just a score.
-
-> **Your code stays on your machine.** Scoring is 100% local — no LLM calls, no code sent anywhere. Generation uses your own AI subscription (Claude Code, Cursor) or your own API key (Anthropic, OpenAI, Vertex AI). Caliber never sees your code.
-
----
-
-Caliber scores, generates, and keeps your AI agent configs in sync with your codebase. It fingerprints your project — languages, frameworks, dependencies, architecture — and produces tailored configs for **Claude Code**, **Cursor**, and **OpenAI Codex**. When your code evolves, Caliber detects the drift and updates your configs to match.
-
 ## Before / After
 
 Most repos start with a hand-written `CLAUDE.md` and nothing else. Here's what Caliber finds — and fixes:
 
 ```
-  Before                                    After caliber init
+  Before                                    After /setup-caliber
   ──────────────────────────────            ──────────────────────────────
 
   Agent Config Score    35 / 100            Agent Config Score    94 / 100
@@ -53,6 +42,24 @@ Scoring is deterministic — no LLM, no API calls. It cross-references your conf
 caliber score --compare main    # See how your branch changed the score
 ```
 
+## Get Started
+
+Requires **Node.js >= 20**.
+
+```bash
+npx @rely-ai/caliber bootstrap
+```
+
+Then, in your next Claude Code or Cursor chat session, type:
+
+> **/setup-caliber**
+
+Your agent detects your stack, generates tailored configs for every platform your team uses, sets up pre-commit hooks, and enables continuous sync — all from inside your normal workflow.
+
+**Don't use Claude Code or Cursor?** Run `caliber init` instead — it's the same setup as a CLI wizard. Works with any LLM provider: bring your own Anthropic, OpenAI, or Vertex AI key.
+
+> **Your code stays on your machine.** Bootstrap is 100% local — no LLM calls, no code sent anywhere. Generation uses your own AI subscription or API key. Caliber never sees your code.
+
 ## Audits first, writes second
 
 Caliber never overwrites your existing configs without asking. The workflow mirrors code review:
@@ -67,26 +74,28 @@ If your existing config scores **95+**, Caliber skips full regeneration and appl
 
 ## How It Works
 
-Caliber is not a one-time setup tool. It's a loop:
+Bootstrap gives your agent the `/setup-caliber` skill. Your agent analyzes your project — languages, frameworks, dependencies, architecture — generates configs, and installs hooks. From there, it's a loop:
 
 ```
-          caliber score
+  npx @rely-ai/caliber bootstrap       ← one-time, 2 seconds
               │
               ▼
-  ┌──── caliber init ◄────────────────┐
-  │     (generate / fix)              │
-  │           │                       │
-  │           ▼                       │
-  │     your code evolves             │
-  │     (new deps, renamed files,     │
-  │      changed architecture)        │
-  │           │                       │
-  │           ▼                       │
-  └──► caliber refresh ──────────────►┘
-       (detect drift, update configs)
+  agent runs /setup-caliber             ← agent handles everything
+              │
+              ▼
+  ┌──── configs generated ◄────────────┐
+  │           │                        │
+  │           ▼                        │
+  │     your code evolves              │
+  │     (new deps, renamed files,      │
+  │      changed architecture)         │
+  │           │                        │
+  │           ▼                        │
+  └──► caliber refresh ──────────────►─┘
+       (auto, on every commit)
 ```
 
-Auto-refresh hooks run this loop automatically — on every commit or at the end of each AI coding session.
+Pre-commit hooks run the refresh loop automatically. New team members get nudged to bootstrap on their first session.
 
 ### What It Generates
 
@@ -106,6 +115,10 @@ Auto-refresh hooks run this loop automatically — on every commit or at the end
 - `AGENTS.md` — Project context for Codex
 - `.agents/skills/*/SKILL.md` — Skills for Codex
 
+**OpenCode**
+- `AGENTS.md` — Project context (shared with Codex when both are targeted)
+- `.opencode/skills/*/SKILL.md` — Skills for OpenCode
+
 ## Key Features
 
 <details>
@@ -118,12 +131,13 @@ TypeScript, Python, Go, Rust, Java, Ruby, Terraform, and more. Language and fram
 <details>
 <summary><strong>Any AI Tool</strong></summary>
 
-Target a single platform or all three at once:
+`caliber bootstrap` auto-detects which agents you have installed. For manual control:
 ```bash
 caliber init --agent claude        # Claude Code only
 caliber init --agent cursor        # Cursor only
 caliber init --agent codex         # Codex only
-caliber init --agent all           # All three
+caliber init --agent opencode      # OpenCode only
+caliber init --agent all           # All platforms
 caliber init --agent claude,cursor # Comma-separated
 ```
 
@@ -197,12 +211,20 @@ The `refresh` command analyzes your git diff (committed, staged, and unstaged ch
 
 </details>
 
+<details>
+<summary><strong>Team Onboarding</strong></summary>
+
+When Caliber is set up in a repo, it automatically nudges new team members to configure it on their machine. A lightweight session hook checks whether the pre-commit hook is installed and prompts setup if not — no manual coordination needed.
+
+</details>
+
 <details>
 <summary><strong>Fully Reversible</strong></summary>
 
 - **Automatic backups** — originals saved to `.caliber/backups/` before every write
 - **Score regression guard** — if a regeneration produces a lower score, changes are auto-reverted
 - **Full undo** — `caliber undo` restores everything to its previous state
+- **Clean uninstall** — `caliber uninstall` removes everything Caliber added (hooks, generated sections, skills, learnings) while preserving your own content
 - **Dry run** — preview changes with `--dry-run` before applying
 
 </details>
@@ -211,9 +233,10 @@ The `refresh` command analyzes your git diff (committed, staged, and unstaged ch
 
 | Command | Description |
 |---|---|
+| `caliber bootstrap` | Install agent skills — the fastest way to get started |
+| `caliber init` | Full setup wizard — analyze, generate, review, install hooks |
 | `caliber score` | Score config quality (deterministic, no LLM) |
 | `caliber score --compare <ref>` | Compare current score against a git ref |
-| `caliber init` | Full setup wizard — analyze, generate, review, install hooks |
 | `caliber regenerate` | Re-analyze and regenerate configs (aliases: `regen`, `re`) |
 | `caliber refresh` | Update docs based on recent code changes |
 | `caliber skills` | Discover and install community skills |
@@ -221,6 +244,7 @@ The `refresh` command analyzes your git diff (committed, staged, and unstaged ch
 | `caliber hooks` | Manage auto-refresh hooks |
 | `caliber config` | Configure LLM provider, API key, and model |
 | `caliber status` | Show current setup status |
+| `caliber uninstall` | Remove all Caliber resources from a project |
 | `caliber undo` | Revert all changes made by Caliber |
 
 ## FAQ
@@ -235,9 +259,16 @@ No. Caliber shows you a diff of every proposed change. You accept, refine, or de
 <details>
 <summary><strong>Does it need an API key?</strong></summary>
 
-**Scoring:** No. `caliber score` runs 100% locally with no LLM.
+**Bootstrap & scoring:** No. Both run 100% locally with no LLM.
+
+**Generation** (via `/setup-caliber` or `caliber init`): Uses your existing Claude Code or Cursor subscription (no API key needed), or bring your own key for Anthropic, OpenAI, or Vertex AI.
+
+</details>
+
+<details>
+<summary><strong>What's the difference between bootstrap and init?</strong></summary>
 
-**Generation:** Uses your existing Claude Code or Cursor subscription (no API key needed), or bring your own key for Anthropic, OpenAI, or Vertex AI.
+`caliber bootstrap` installs agent skills in 2 seconds — your agent then runs `/setup-caliber` to handle the rest from inside your session. `caliber init` is the full interactive wizard for users who prefer a CLI-driven setup. Both end up in the same place.
 
 </details>
 
@@ -258,24 +289,10 @@ Yes. Run `caliber init` from any directory. `caliber refresh` can update configs
 <details>
 <summary><strong>Does it send my code anywhere?</strong></summary>
 
-Scoring is fully local. Generation sends your project fingerprint (not source code) to whatever LLM provider you configure — the same provider your AI editor already uses. Anonymous usage analytics (no code, no file contents) can be disabled via `caliber config`.
+Scoring is fully local. Generation sends a project summary (languages, structure, dependencies — not source code) to whatever LLM provider you configure — the same provider your AI editor already uses. Anonymous usage analytics (no code, no file contents) can be disabled via `caliber config`.
 
 </details>
 
-## Add a Caliber badge to your repo
-
-After scoring your project, add a badge to your README:
-
-![Caliber Score](https://img.shields.io/badge/caliber-94%2F100-brightgreen)
-
-Copy this markdown and replace `94` with your actual score:
-
-```
-![Caliber Score](https://img.shields.io/badge/caliber-SCORE%2F100-COLOR)
-```
-
-Color guide: `brightgreen` (90+), `green` (70-89), `yellow` (40-69), `red` (<40).
-
 ## LLM Providers
 
 No API key? No problem. Caliber works with your existing AI tool subscription:
@@ -333,11 +350,6 @@ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json
 
 </details>
 
-## Requirements
-
-- **Node.js** >= 20
-- **One LLM provider:** your **Claude Code** or **Cursor** subscription (no API key), or an API key for Anthropic / OpenAI / Vertex AI
-
 ## Contributing
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines.
@@ -353,6 +365,20 @@ npm run build    # Compile
 
 Uses [conventional commits](https://www.conventionalcommits.org/) — `feat:` for features, `fix:` for bug fixes.
 
+## Add a Caliber badge to your repo
+
+After scoring your project, add a badge to your README:
+
+![Caliber Score](https://img.shields.io/badge/caliber-94%2F100-brightgreen)
+
+Copy this markdown and replace `94` with your actual score:
+
+```
+![Caliber Score](https://img.shields.io/badge/caliber-SCORE%2F100-COLOR)
+```
+
+Color guide: `brightgreen` (90+), `green` (70-89), `yellow` (40-69), `red` (<40).
+
 ## License
 
 MIT