Skip to content

Commit e4e7f79

Browse files
committed
docs(agents): update AGENTS.md files to reflect current codebase
- Add prerequisites.py module (20→21 modules) - Add cleanup.sh, reset_pins.sh scripts (28→30 scripts) - Add test_prerequisites.py (12→13 test files) - Update catalog count (78→79 entries) - Add new make targets: cleanup, upgrade-ignore-pins, reset-pins, upgrade-all
1 parent ec368f5 commit e4e7f79

4 files changed

Lines changed: 23 additions & 15 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- Managed by agent: keep sections and order; edit content, not structure. Last updated: 2026-01-16 -->
1+
<!-- Managed by agent: keep sections and order; edit content, not structure. Last updated: 2026-02-06 -->
22

33
# AGENTS.md (root)
44

@@ -41,9 +41,9 @@ uv run python audit.py --help # Verify CLI works
4141

4242
## Index of scoped AGENTS.md
4343

44-
- [cli_audit/AGENTS.md](./cli_audit/AGENTS.md) — Python package (20 modules)
45-
- [scripts/AGENTS.md](./scripts/AGENTS.md) — Installation scripts (Bash)
46-
- [tests/AGENTS.md](./tests/AGENTS.md) — Test suite (pytest)
44+
- [cli_audit/AGENTS.md](./cli_audit/AGENTS.md) — Python package (21 modules)
45+
- [scripts/AGENTS.md](./scripts/AGENTS.md) — Installation scripts (Bash, 30 scripts)
46+
- [tests/AGENTS.md](./tests/AGENTS.md) — Test suite (pytest, 14 test files)
4747

4848
## Quick reference
4949

@@ -60,8 +60,12 @@ uv run python audit.py --help # Verify CLI works
6060
| `make update-local` | Update only local state (no network) |
6161
| `make update-baseline` | Update upstream baseline for commit |
6262
| `make upgrade` | Interactive upgrade guide |
63+
| `make cleanup` | Interactive tool removal |
6364
| `make upgrade-managed` | Upgrade all package managers |
6465
| `make upgrade-dry-run` | Preview upgrades without changes |
66+
| `make upgrade-ignore-pins` | Upgrade guide ignoring version pins |
67+
| `make reset-pins` | Remove all version pins |
68+
| `make upgrade-all` | Full system upgrade (data + managers + tools) |
6569
| `./scripts/set_auto_update.sh <tool>` | Enable auto-update for a tool |
6670
| `uv run python audit.py --versions` | Show multi-version runtime status |
6771
| `uv run python audit.py --versions php` | Show specific runtime versions |
@@ -79,7 +83,7 @@ uv run python audit.py --help # Verify CLI works
7983

8084
**AI CLI Preparation v2.0** — Tool version auditing and installation management for AI coding agents.
8185

82-
- **Architecture:** 20 Python modules, 78 JSON tool catalogs
86+
- **Architecture:** 21 Python modules, 79 JSON tool catalogs
8387
- **Phase 1:** Detection & auditing (complete)
8488
- **Phase 2:** Installation & upgrade management (complete)
8589
- **Entry point:** `audit.py``cli_audit` package

cli_audit/AGENTS.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2026-01-16 -->
1+
<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2026-02-06 -->
22

33
# cli_audit/ — Python Package
44

5-
**Modular architecture** with 20 specialized modules for tool detection, auditing, installation, and upgrade management.
5+
**Modular architecture** with 21 specialized modules for tool detection, auditing, installation, and upgrade management.
66

77
## Overview
88

99
The `cli_audit` package provides the core functionality for AI CLI Preparation:
1010

1111
**Phase 1: Detection & Auditing (6 modules)**
1212
- `tools.py` — Tool definitions and metadata
13-
- `catalog.py` — JSON catalog management (78 entries)
13+
- `catalog.py` — JSON catalog management (79 entries)
1414
- `detection.py` — Installation detection, version extraction, multi-version detection
1515
- `collectors.py` — Upstream version collection (GitHub, PyPI, npm, crates, endoflife.date)
1616
- `snapshot.py` — Snapshot-based caching
@@ -23,9 +23,10 @@ The `cli_audit` package provides the core functionality for AI CLI Preparation:
2323
- `package_managers.py` — Package manager abstractions
2424
- `logging_config.py` — Logging configuration
2525

26-
**Phase 2: Installation & Upgrade (4 modules)**
26+
**Phase 2: Installation & Upgrade (5 modules)**
2727
- `installer.py` — Tool installation with retry/validation
2828
- `install_plan.py` — Installation planning, dependency resolution
29+
- `prerequisites.py` — Prerequisite resolution and dependency chain handling
2930
- `bulk.py` — Parallel bulk operations
3031
- `upgrade.py` — Upgrade workflows
3132

@@ -51,7 +52,7 @@ local_state.json # Gitignored - machine-specific installation state
5152
~/.config/cli-audit/config.yml # User preferences (auto_update, tool overrides)
5253
```
5354

54-
**Catalog entries** (78 JSON files in `catalog/`):
55+
**Catalog entries** (79 JSON files in `catalog/`):
5556
- Each tool has `name`, `candidates`, `source_kind`, `source_args`, `category`
5657
- Categories: python, node, go, rust, ruby, php, shell, git, devops, platform, ai, general
5758
- User preferences (auto_update) stored in user config, not catalog

scripts/AGENTS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2026-01-16 -->
1+
<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2026-02-06 -->
22

33
# Installation Scripts - Agent Guide
44

55
**Scope:** Shell scripts for tool installation, update, uninstall, reconcile
66

77
## Overview
88

9-
28 Bash scripts for installing developer tools with multiple actions:
9+
30 Bash scripts for installing developer tools with multiple actions:
1010
- **install**: Fresh installation (default action)
1111
- **update**: Upgrade to latest version
1212
- **uninstall**: Remove installation
@@ -33,6 +33,8 @@
3333
- `auto_update.sh`: Automatic update runner
3434
- `set_auto_update.sh`: Enable/disable auto-update per tool
3535
- `pin_version.sh`, `unpin_version.sh`: Version pinning
36+
- `reset_pins.sh`: Remove all version pins from all tools
37+
- `cleanup.sh`: Interactive removal of installed tools
3638

3739
**Reconciliation:**
3840
- `reconcile_pip_to_uv.sh`: Migrate pip packages to uv

tests/AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2026-01-16 -->
1+
<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2026-02-06 -->
22

33
# tests/ — Test Suite
44

55
**Comprehensive testing** with unit, integration, and E2E tests for the modular cli_audit package.
66

77
## Overview
88

9-
The test suite validates all 20 modules across Phase 1 (Detection & Auditing) and Phase 2 (Installation & Upgrade Management).
9+
The test suite validates all 21 modules across Phase 1 (Detection & Auditing) and Phase 2 (Installation & Upgrade Management).
1010

1111
**Test organization:**
1212
```
@@ -20,6 +20,7 @@ tests/
2020
├── test_local_state.py # Local state management
2121
├── test_logging.py # Logging configuration
2222
├── test_package_managers.py # Package manager abstractions
23+
├── test_prerequisites.py # Prerequisite resolution
2324
├── test_reconcile.py # Duplicate cleanup
2425
├── test_upgrade.py # Upgrade workflows
2526
├── test_upstream_cache.py # Upstream cache management
@@ -28,7 +29,7 @@ tests/
2829
```
2930

3031
**Test coverage:**
31-
- 12 unit test files covering all 20 modules
32+
- 13 unit test files covering all 21 modules
3233
- 1 integration test directory
3334
- Fixtures for mocking external services
3435

0 commit comments

Comments
 (0)