From 0433729cd589124b139245a58f0dab29a3d2777e Mon Sep 17 00:00:00 2001 From: Claude Date: Sat, 16 May 2026 07:16:51 +0000 Subject: [PATCH] docs: fix four doc/implementation misalignments found in alignment audit - Remove broken refs to docs/contributing/ (deleted in May 15 rewrite) - Fix index.md and managing.md claiming agr init writes .gitignore entries (no gitignore code exists anywhere in the implementation) - Add upgrade and run to command lists in CLAUDE.md and AGENTS.md - Update AGENTS.md dependency type description to mention ralphs (not "always skill") https://claude.ai/code/session_01RoQiPqMvCK3JRVLPo1UfDj --- AGENTS.md | 8 +++----- CLAUDE.md | 4 +--- docs/index.md | 3 +-- docs/managing.md | 2 +- 4 files changed, 6 insertions(+), 11 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 486c1c5..6b29a9c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -26,11 +26,9 @@ uv run agrx --help Two CLI tools share a common core library: -- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: add, remove, sync, list, init, config. +- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: init, add, remove, sync, upgrade, list, run, config. - **`agrx`** — Ephemeral skill runner (`agrx/main.py`). Downloads and runs a skill without persisting it. -For detailed architecture, contributing guides, code patterns, and recipes, see `docs/contributing/`. - ## agr.toml Format The configuration file uses a flat array of dependencies: @@ -44,11 +42,11 @@ dependencies = [ ``` Each dependency has: -- `type`: Always "skill" for now +- `type`: `"skill"` or `"ralph"`. Skills install into each configured tool's skills dir; ralphs install once into `.agents/ralphs//` (project-scoped, no per-tool fan-out, no global installs). - `handle`: Remote GitHub reference (username/repo/skill or username/skill) - `path`: Local path (alternative to handle) -Future: A `tools` section will configure which tools to sync to: +The `tools` section configures which tools to sync to: ```toml tools = ["claude", "cursor"] ``` diff --git a/CLAUDE.md b/CLAUDE.md index c801768..8733d82 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -26,11 +26,9 @@ uv run agrx --help Two CLI tools share a common core library: -- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: add, remove, sync, list, init, config. +- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: init, add, remove, sync, upgrade, list, run, config. - **`agrx`** — Ephemeral skill runner (`agrx/main.py`). Downloads and runs a skill without persisting it. -For detailed architecture, contributing guides, code patterns, and recipes, see `docs/contributing/`. - ## agr.toml Format The configuration file uses a flat array of dependencies: diff --git a/docs/index.md b/docs/index.md index e4a8afd..44eee47 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,8 +40,7 @@ cd my-project agr init ``` -Writes a starter `agr.toml` and adds the per-tool skill directories to -`.gitignore`. +Writes a starter `agr.toml`. ### 3. Add a skill diff --git a/docs/managing.md b/docs/managing.md index dc92fbc..8434803 100644 --- a/docs/managing.md +++ b/docs/managing.md @@ -80,7 +80,7 @@ Skill directories are built artifacts. Commit the manifest, ignore the build. .agents/skills/ ``` -`agr init` writes these for you. +Add these to your project's `.gitignore` manually. ## Multi-tool