john/tractatus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(framework): update ffs command documentation with --tokens parameter

Browse source 
- Document --tokens=<current>/<budget> parameter for real-time pressure
- Add warning about cached data being potentially stale
- Mark --tokens usage as recommended best practice

Note: CLAUDE.md is internal developer documentation, port exposure is acceptable

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
TheFlow 2025-10-29 11:01:50 +13:00
parent 1c4b1dfda2
commit 7dff0a16ee
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CLAUDE.md
View file

@ -68,6 +68,10 @@ node scripts/framework-audit-response.js \
When user types **ffs**, display full framework statistics: When user types **ffs**, display full framework statistics:
```bash ```bash
# With real-time context pressure (recommended)
node scripts/framework-stats.js --tokens=<current>/<budget>
# With cached data (may be stale)
node scripts/framework-stats.js node scripts/framework-stats.js
``` ```
@ -76,13 +80,15 @@ node scripts/framework-stats.js
**Reports**: **Reports**:
- Session state (ID, message count, status) - Session state (ID, message count, status)
- Token usage & checkpoints (25%, 50%, 75%) - Token usage & checkpoints (25%, 50%, 75%)
- Context pressure level & metrics - Context pressure level & metrics (real-time when --tokens provided)
- Instruction counts (by quadrant/persistence) - Instruction counts (by quadrant/persistence)
- Audit log counts (by service) - Audit log counts (by service)
- Framework service status (all 6 services) - Framework service status (all 6 services)
**Output**: Formatted report + JSON for programmatic access **Output**: Formatted report + JSON for programmatic access
**Important**: Use `--tokens=` parameter for accurate real-time pressure. Without it, displays cached session data which may show 0% pressure.
**When**: User wants to see framework health/activity at any point in session **When**: User wants to see framework health/activity at any point in session
**See**: inst_082 in instruction-history.json **See**: inst_082 in instruction-history.json