|
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 --> |
2 | 2 |
|
3 | 3 | # AGENTS.md (root) |
4 | 4 |
|
5 | 5 | **Precedence:** The **closest AGENTS.md** to changed files wins. Root holds global defaults only. |
6 | 6 |
|
7 | 7 | ## Global rules |
8 | 8 |
|
9 | | -- Keep PRs small (~≤300 net LOC changed) |
| 9 | +- Keep PRs small (~≤300 net LOC) |
10 | 10 | - Conventional Commits: `type(scope): description` |
11 | 11 | - Types: feat, fix, docs, chore, test, refactor, perf, style |
12 | 12 | - Scopes: audit, catalog, scripts, docs, tests |
13 | | -- Ask before: heavy dependencies, full rewrites, breaking changes |
| 13 | +- Ask before: heavy deps, full rewrites, breaking changes |
14 | 14 | - Never commit secrets, PII, or credentials |
15 | 15 |
|
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 | | - |
26 | 16 | ## Minimal pre-commit checks |
27 | 17 |
|
28 | 18 | ```bash |
29 | | -# Linting |
30 | 19 | make lint # flake8 (required) |
31 | | - |
32 | | -# Type checking (optional) |
33 | | -make lint-types # mypy |
34 | | - |
35 | | -# Testing |
| 20 | +make lint-types # mypy (optional) |
36 | 21 | ./scripts/test_smoke.sh # Smoke tests (required) |
37 | | - |
38 | | -# Audit validation |
39 | 22 | make audit # Verify core workflows |
40 | 23 | ``` |
41 | 24 |
|
42 | 25 | ## Index of scoped AGENTS.md |
43 | 26 |
|
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) |
47 | 30 |
|
48 | 31 | ## Quick reference |
49 | 32 |
|
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 | |
56 | 40 |
|
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 |
61 | 42 |
|
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. |
68 | 44 |
|
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 |
74 | 49 |
|
75 | 50 | ## When instructions conflict |
76 | 51 |
|
|
0 commit comments