Skip to content

Commit 0f2fc84

Browse files
CybotTMclaude
andcommitted
docs: update for alpha.6 + perf: remove shortcuts (2,658x speedup)
Documentation Updates (alpha.6): - Update version to 2.0.0-alpha.6 in PHASE2_COMPLETION_REPORT.md - Document upgrade-all 5-stage workflow in DEPLOYMENT.md - Add upgrade-all commands to QUICK_REFERENCE.md and CLI_REFERENCE.md - Update project context (claudedocs/) with recent features - Validate all documentation cross-references Performance Fix (Critical): - Remove Makefile.d/shortcuts.mk completely (50s overhead per command) - Clean up Makefile shortcuts include directive - Performance: 53s → 0.020s (2,658x faster for make user-help) - All commands now execute in <0.1s Version Updates: - Update Claude Code dependency: 2.0.11 → 2.0.22 - Update latest_versions.json with version flag improvements - Refresh tools_snapshot.json cache 🎉 Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 9b784ed commit 0f2fc84

11 files changed

Lines changed: 518 additions & 387 deletions

Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,3 @@ help: ## Show complete help with all commands
6969
include Makefile.d/user.mk
7070
include Makefile.d/dev.mk
7171
include Makefile.d/maint.mk
72-
73-
# Shortcuts must be last to act as catch-all
74-
include Makefile.d/shortcuts.mk

Makefile.d/shortcuts.mk

Lines changed: 0 additions & 44 deletions
This file was deleted.

claudedocs/project_context.md

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# AI CLI Preparation - Project Context (AI Agent Reference)
22

3-
**Last Updated:** 2025-10-13
3+
**Last Updated:** 2025-10-18
4+
**Version:** 2.0.0-alpha.6
45
**For:** AI Coding Agents (Claude Code, etc.)
56

67
## Quick Reference
78

8-
**Purpose:** Environment audit tool ensuring AI coding agents have all necessary CLI tools installed and current
9+
**Purpose:** Environment audit and tool management system ensuring AI coding agents have all necessary CLI tools installed, current, and properly configured
910

1011
**Repository:** github.com/netresearch/coding_agent_cli_toolset
1112
**Primary Language:** Python 3.9+ (dev: 3.14.0rc2)
12-
**Architecture:** Offline-first, parallel, resilient tool version auditing
13-
**Tool Coverage:** 64 tools across 10 categories (50+ production, rest in development)
13+
**Architecture:** Offline-first, parallel, resilient tool version auditing with comprehensive upgrade orchestration
14+
**Tool Coverage:** 64 tools across 10 categories
15+
**Phase Status:** Phase 1 (Audit) Complete | Phase 2 (Install/Upgrade) Alpha
1416

1517
## Core Capabilities
1618

@@ -121,10 +123,39 @@ make update
121123
# Interactive upgrade guide
122124
make upgrade
123125

126+
# Complete system upgrade (5 stages)
127+
make upgrade-all
128+
129+
# Preview system upgrade (dry-run)
130+
make upgrade-all-dry-run
131+
124132
# Offline audit with hints
125133
make audit-offline
126134
```
127135

136+
### System-Wide Upgrade (New in alpha.6)
137+
```bash
138+
# 5-Stage orchestrated upgrade workflow
139+
make upgrade-all
140+
# Stage 1: Refresh version data
141+
# Stage 2: Upgrade package managers (apt, brew, snap, flatpak)
142+
# Stage 3: Upgrade runtimes (Python, Node.js, Go, Ruby, Rust)
143+
# Stage 4: Upgrade user package managers (uv, pipx, npm, pnpm, yarn, cargo, etc.)
144+
# Stage 5: Upgrade all CLI tools
145+
146+
# Features:
147+
# - UV migration (auto-migrates pip/pipx to uv tools)
148+
# - System package detection (skips apt/brew managed)
149+
# - Comprehensive logging (logs/upgrade-YYYYMMDD-HHMMSS.log)
150+
# - Dry-run mode available
151+
152+
# Preview without making changes
153+
make upgrade-all-dry-run
154+
155+
# Check PATH configuration
156+
make check-path
157+
```
158+
128159
### Role-Based Audits
129160
```bash
130161
make audit-offline-agent-core # AI agent essentials
@@ -213,20 +244,25 @@ CLI_AUDIT_TRACE=1 python3 cli_audit.py
213244

214245
## Current Git State
215246

216-
**Branch:** main (12 commits ahead of origin/main)
217-
**Working Tree:** Clean
218-
**Modified:** .env (GITHUB_TOKEN + CLI_AUDIT_MAX_WORKERS=40), tools_snapshot.json
247+
**Branch:** main
248+
**Working Tree:** Modified (documentation updates in progress)
249+
**Modified:** latest_versions.json, package.json, package-lock.json, tools_snapshot.json, docs/
219250
**Untracked:** node_modules/
220251
**Remote:** git@github.com:netresearch/coding_agent_cli_toolset.git
221252

222-
**Recent commits (2025-10-13):**
253+
**Recent commits (2025-10-18 - upgrade-all feature):**
254+
- 9b784ed - chore: update version snapshots
255+
- 22c1603 - feat(upgrade-all): add UV migration for pip/pipx packages
256+
- 1b71b71 - feat(upgrade-all): skip pip/pipx when uv is managing Python packages
257+
- cceed18 - fix(upgrade-all): detect pipx packages with missing metadata and provide fix
258+
- 7d691cb - feat(upgrade-all): add comprehensive version and location info to all upgrade stages
259+
260+
**Recent commits (2025-10-13 - environment fixes):**
223261
- 34fa37f - chore(snapshot): update tool audit cache with improved detection
224262
- 80abd30 - fix(guide): clarify Docker CLI vs Docker Engine terminology
225263
- aa57210 - fix(cli_audit): resolve three critical issues in environment and detection
226-
- d092236 - feat(docker): detect client version explicitly, not server
227-
- 2237226 - fix(cli_audit): resolve three issues in make update
228264

229-
**Recent commits (2025-10-09):**
265+
**Recent commits (2025-10-09 - documentation):**
230266
- 0c7ade3 - Snapshot-based collect/render modes
231267
- 3dd5082 - Lock ordering fixes (thread safety)
232268
- c160361 - Classification improvements (shebang detection)

docs/CLI_REFERENCE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ make update # Collect data (network required)
4141
make audit # Render table (offline)
4242
make audit-auto # Update if missing, then render
4343

44+
# System-wide upgrade
45+
make upgrade-all # Complete 5-stage system upgrade
46+
make upgrade-all-dry-run # Preview without making changes
47+
make check-path # Validate PATH configuration
48+
4449
# Installation (Makefile)
4550
make install-core
4651
make install-python
@@ -254,6 +259,37 @@ make audit-auto
254259
make upgrade
255260
```
256261

262+
### System-Wide Upgrade
263+
264+
```bash
265+
# Complete system upgrade (5 stages: data → managers → runtimes → user managers → tools)
266+
make upgrade-all
267+
268+
# Preview upgrade without making changes (dry-run)
269+
make upgrade-all-dry-run
270+
271+
# Check PATH configuration before upgrading
272+
make check-path
273+
```
274+
275+
**5-Stage Workflow:**
276+
1. Refresh version data from upstream
277+
2. Upgrade system package managers (apt, brew, snap, flatpak)
278+
3. Upgrade language runtimes (Python, Node.js, Go, Ruby, Rust)
279+
4. Upgrade user package managers (uv, pipx, npm, pnpm, yarn, cargo, composer, poetry)
280+
5. Upgrade all CLI tools managed by each package manager
281+
282+
**Features:**
283+
- UV migration (auto-migrates pip/pipx packages to uv tools)
284+
- System package detection (skips system-managed tools)
285+
- Comprehensive logging to `logs/upgrade-YYYYMMDD-HHMMSS.log`
286+
- Colored output with statistics summary
287+
288+
**Environment Variables:**
289+
- `DRY_RUN=1` - Preview mode
290+
- `SKIP_SYSTEM=1` - Skip system package managers
291+
- `VERBOSE=1` - Detailed output
292+
257293
### Installation Scripts
258294

259295
**Core Tools:**

docs/DEPLOYMENT.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,103 @@ Interactive remediation guide (renamed from `guide`).
100100
make upgrade
101101
```
102102

103+
### System-Wide Upgrade Targets
104+
105+
#### `make upgrade-all`
106+
Complete system upgrade in 5 orchestrated stages.
107+
108+
**Workflow:**
109+
1. **Stage 1: Refresh Data** - Update version snapshot from upstream sources
110+
2. **Stage 2: Upgrade Package Managers** - Self-update system package managers (apt, brew, snap, flatpak)
111+
3. **Stage 3: Upgrade Language Runtimes** - Update core runtimes (Python, Node.js, Go, Ruby, Rust)
112+
4. **Stage 4: Upgrade User Package Managers** - Update language-specific managers (uv, pipx, npm, pnpm, yarn, cargo, composer, poetry)
113+
5. **Stage 5: Upgrade Tools** - Upgrade all CLI tools managed by each package manager
114+
115+
**Features:**
116+
- Comprehensive logging to `logs/upgrade-YYYYMMDD-HHMMSS.log`
117+
- Colored terminal output with progress tracking
118+
- Version and location info for successful upgrades
119+
- UV migration support (auto-migrates pip/pipx packages to uv tools)
120+
- System package detection (skips system-managed tools, suggests reconcile)
121+
- Statistics summary (upgraded/failed/skipped counts)
122+
- Dry-run mode available
123+
124+
**Use Case:** Complete development environment upgrade, ensuring all tools across all package managers are current.
125+
126+
**Duration:** 5-15 minutes depending on number of outdated packages.
127+
128+
```bash
129+
# Full system upgrade
130+
make upgrade-all
131+
132+
# Preview what would be upgraded (dry-run)
133+
make upgrade-all-dry-run
134+
```
135+
136+
**Output Example:**
137+
```
138+
[1/5] Stage 1: Refresh version data
139+
✓ Updated snapshot (64 tools checked)
140+
141+
[2/5] Stage 2: Upgrade package managers
142+
✓ apt (upgraded 12 packages)
143+
⏭ homebrew (not installed)
144+
✓ snap (2.63 at /usr/bin/snap)
145+
146+
[3/5] Stage 3: Upgrade language runtimes
147+
✓ python (3.12.7 → 3.12.8)
148+
✓ node (20.10.0 → 20.11.0)
149+
⏭ go (already latest: 1.22.0)
150+
151+
[4/5] Stage 4: Upgrade user package managers
152+
✓ uv (0.4.30 → 0.5.0)
153+
✓ pipx (1.7.1 → 1.8.0)
154+
→ Migrating pip packages to uv...
155+
✓ black migrated to uv tool
156+
✓ ruff migrated to uv tool
157+
158+
[5/5] Stage 5: Upgrade CLI tools
159+
✓ Upgraded 8 uv tools
160+
✓ Upgraded 15 npm packages
161+
✓ Upgraded 3 cargo binaries
162+
163+
Summary: 45 upgraded, 12 skipped, 2 failed
164+
Duration: 8m 32s
165+
Log: logs/upgrade-20251018-073045.log
166+
```
167+
168+
**Environment Variables:**
169+
- `DRY_RUN=1` - Preview mode without making changes
170+
- `SKIP_SYSTEM=1` - Skip system package managers (apt, brew, snap, flatpak)
171+
- `VERBOSE=1` - Detailed output for debugging
172+
173+
**Advanced:**
174+
```bash
175+
# Direct script execution with options
176+
DRY_RUN=1 VERBOSE=1 bash scripts/upgrade_all.sh
177+
178+
# Skip system package managers
179+
SKIP_SYSTEM=1 make upgrade-all
180+
181+
# Check PATH configuration before upgrading
182+
make check-path
183+
```
184+
185+
#### `make check-path`
186+
Validate PATH configuration for all package managers.
187+
188+
**Behavior:**
189+
- Checks if package manager binaries are in PATH
190+
- Validates PATH ordering (user bins before system bins)
191+
- Identifies potential shadowing issues
192+
- Provides remediation suggestions
193+
194+
**Use Case:** Diagnose PATH issues before or after system upgrade.
195+
196+
```bash
197+
make check-path
198+
```
199+
103200
### Tool-Specific Audit Targets
104201

105202
#### `make audit-TOOLNAME`

docs/PHASE2_COMPLETION_REPORT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Phase 2 Completion Report
22

3-
**Version:** 2.0.0-alpha.5
4-
**Completion Date:** 2025-10-09
3+
**Version:** 2.0.0-alpha.6
4+
**Completion Date:** 2025-10-15
55
**Status:** ✅ COMPLETE - Ready for Beta
66

77
---

docs/QUICK_REFERENCE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ make audit-offline
1919
# Interactive upgrade guide
2020
make upgrade
2121

22+
# Complete system upgrade (5 stages: data → managers → runtimes → user managers → tools)
23+
make upgrade-all
24+
25+
# Preview system upgrade (dry-run)
26+
make upgrade-all-dry-run
27+
28+
# Check PATH configuration
29+
make check-path
30+
2231
# Single tool check
2332
python3 cli_audit.py --only ripgrep | python3 smart_column.py -s "|" -t
2433
```

latest_versions.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
"gh:universal-ctags/ctags": "latest_redirect",
4848
"gh:wagoodman/dive": "latest_redirect",
4949
"gh:watchexec/watchexec": "latest_redirect",
50-
"local_dc:docker-compose": "legacy",
50+
"local_dc:docker-compose": "plugin",
5151
"local_flag:ast-grep": "--version",
5252
"local_flag:aws": "--version",
5353
"local_flag:bandit": "--version",
@@ -61,7 +61,7 @@
6161
"local_flag:delta": "--version",
6262
"local_flag:direnv": "--version",
6363
"local_flag:dive": "--version",
64-
"local_flag:docker": "--version",
64+
"local_flag:docker": "version --format {{.Client.Version}}",
6565
"local_flag:eslint": "--version",
6666
"local_flag:fd": "--version",
6767
"local_flag:flake8": "--version",
@@ -72,7 +72,7 @@
7272
"local_flag:git": "--version",
7373
"local_flag:git-absorb": "--version",
7474
"local_flag:git-lfs": "-v",
75-
"local_flag:gitleaks": "--version",
75+
"local_flag:gitleaks": "version",
7676
"local_flag:glab": "--version",
7777
"local_flag:go": "version",
7878
"local_flag:golangci-lint": "--version",

package-lock.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"dependencies": {
3-
"@anthropic-ai/claude-code": "^2.0.11"
3+
"@anthropic-ai/claude-code": "^2.0.22"
44
}
55
}

0 commit comments

Comments
 (0)