Skip to content

Commit a5975dc

Browse files
committed
docs(agents): update AGENTS.md files following public convention
- Rewrite root AGENTS.md to thin pattern (~50 lines) - Fix link format with ./ prefix for scoped files - Rename section headers in scripts/AGENTS.md to match schema - Update tools_snapshot.json with current state
1 parent 808c641 commit a5975dc

3 files changed

Lines changed: 352 additions & 377 deletions

File tree

AGENTS.md

Lines changed: 20 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,51 @@
1-
<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2025-11-29 -->
1+
<!-- Managed by agent: keep sections and order; edit content, not structure. Last updated: 2025-11-29 -->
22

33
# AGENTS.md (root)
44

55
**Precedence:** The **closest AGENTS.md** to changed files wins. Root holds global defaults only.
66

77
## Global rules
88

9-
- Keep PRs small (~≤300 net LOC changed)
9+
- Keep PRs small (~≤300 net LOC)
1010
- Conventional Commits: `type(scope): description`
1111
- Types: feat, fix, docs, chore, test, refactor, perf, style
1212
- Scopes: audit, catalog, scripts, docs, tests
13-
- Ask before: heavy dependencies, full rewrites, breaking changes
13+
- Ask before: heavy deps, full rewrites, breaking changes
1414
- Never commit secrets, PII, or credentials
1515

16-
## Project overview
17-
18-
**AI CLI Preparation v2.0** - Tool version auditing and installation management for AI coding agents.
19-
20-
**Architecture:** Modular design with 18 specialized Python modules, 74 JSON tool catalogs, and comprehensive testing.
21-
22-
- **Phase 1 (Complete):** Detection & auditing with modular refactoring
23-
- **Phase 2 (Complete):** Installation & upgrade management
24-
- **Entry Point:** `audit.py` (50 lines) → cli_audit package
25-
2616
## Minimal pre-commit checks
2717

2818
```bash
29-
# Linting
3019
make lint # flake8 (required)
31-
32-
# Type checking (optional)
33-
make lint-types # mypy
34-
35-
# Testing
20+
make lint-types # mypy (optional)
3621
./scripts/test_smoke.sh # Smoke tests (required)
37-
38-
# Audit validation
3922
make audit # Verify core workflows
4023
```
4124

4225
## Index of scoped AGENTS.md
4326

44-
- **[cli_audit/AGENTS.md](cli_audit/AGENTS.md)** — Python package (18 modules, Phase 1 + Phase 2)
45-
- **[tests/AGENTS.md](tests/AGENTS.md)**Test suite (unit, integration, E2E)
46-
- **[scripts/AGENTS.md](scripts/AGENTS.md)**Installation scripts (Bash, 25+ scripts)
27+
- [cli_audit/AGENTS.md](./cli_audit/AGENTS.md) — Python package (18 modules)
28+
- [scripts/AGENTS.md](./scripts/AGENTS.md)Installation scripts (Bash)
29+
- [tests/AGENTS.md](./tests/AGENTS.md)Test suite (pytest)
4730

4831
## Quick reference
4932

50-
**Common commands:**
51-
```bash
52-
make audit # Render from snapshot (<100ms)
53-
make update # Collect fresh versions (~7s)
54-
make upgrade # Interactive upgrade guide
55-
make upgrade-all # Complete 5-stage system upgrade
33+
| Command | Purpose |
34+
|---------|---------|
35+
| `make audit` | Render from snapshot (<100ms) |
36+
| `make update` | Collect fresh versions (~7s) |
37+
| `make upgrade` | Interactive upgrade guide |
38+
| `make upgrade-all` | Complete 5-stage system upgrade |
39+
| `python3 audit.py ripgrep` | Single tool audit |
5640

57-
python3 audit.py # Direct invocation
58-
python3 audit.py ripgrep # Single tool audit
59-
python3 audit.py --update ripgrep # Update single tool
60-
```
41+
## Project overview
6142

62-
**Key files:**
63-
- `audit.py` — Entry point
64-
- `cli_audit/` — 18 Python modules (~7K lines)
65-
- `catalog/` — 74 JSON tool definitions
66-
- `latest_versions.json` — Version cache
67-
- `tools_snapshot.json` — Snapshot data
43+
**AI CLI Preparation v2.0** — Tool version auditing and installation management for AI coding agents.
6844

69-
**Documentation:**
70-
- `docs/INDEX.md` — Documentation navigation
71-
- `docs/MIGRATION_GUIDE.md` — v1.x → v2.0 transition
72-
- `docs/CATALOG_GUIDE.md` — JSON catalog system
73-
- `docs/ARCHITECTURE.md` — Modular design
45+
- **Architecture:** 18 Python modules, 74 JSON tool catalogs
46+
- **Phase 1:** Detection & auditing (complete)
47+
- **Phase 2:** Installation & upgrade management (complete)
48+
- **Entry point:** `audit.py``cli_audit` package
7449

7550
## When instructions conflict
7651

scripts/AGENTS.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
**Shared utilities:** `lib/` directory (colors, logging, common functions)
2525

26-
## Setup
26+
## Setup & environment
2727

2828
**Requirements:**
2929
- Bash 4.0+
@@ -43,7 +43,7 @@ DEBUG=1 # Verbose output
4343
make scripts-perms # Ensure all scripts are executable
4444
```
4545

46-
## Build & Tests
46+
## Build & tests
4747

4848
**Run individual script:**
4949
```bash
@@ -79,7 +79,7 @@ DEBUG=1 ./scripts/install_python.sh
7979
bash -x ./scripts/install_python.sh # Trace execution
8080
```
8181

82-
## Code Style
82+
## Code style & conventions
8383

8484
**Shell standards:**
8585
- Bash 4.0+ features allowed
@@ -165,7 +165,7 @@ if [[ "${FORCE_INSTALL:-0}" != "1" ]]; then
165165
fi
166166
```
167167

168-
## Security
168+
## Security & safety
169169

170170
**Download verification:**
171171
```bash
@@ -213,7 +213,7 @@ fi
213213
- Use environment variables: `${GITHUB_TOKEN:-}`
214214
- Document required env vars in script comments
215215

216-
## PR/Commit Checklist
216+
## PR/commit checklist
217217

218218
**Before commit:**
219219
- [ ] Run `shellcheck <script>` (if available)
@@ -237,7 +237,7 @@ fi
237237
- `fix(install-python): handle uv bootstrap failure`
238238
- `docs(scripts): update README with reconcile action`
239239

240-
## Good vs Bad Examples
240+
## Good vs. bad examples
241241

242242
**Good: Robust download with fallback**
243243
```bash
@@ -326,7 +326,7 @@ update_rust() {
326326
}
327327
```
328328

329-
## When Stuck
329+
## When stuck
330330

331331
**Script fails silently:**
332332
1. Add debug: `bash -x ./scripts/install_<tool>.sh`
@@ -358,7 +358,7 @@ update_rust() {
358358
- Troubleshooting: [../docs/TROUBLESHOOTING.md](../docs/TROUBLESHOOTING.md)
359359
- Architecture: [../docs/DEPLOYMENT.md](../docs/DEPLOYMENT.md#installation-scripts)
360360

361-
## House Rules
361+
## House rules
362362

363363
**Installation preferences** (Phase 2 planning):
364364
- User-level preferred: `~/.local/bin` (workstations)

0 commit comments

Comments
 (0)