OpenWriterControle/.opencode/context/openagents-repo/lookup/commands.md
Darren Hinde c8f7103cb6
refactor(evals): consolidate documentation and enhance test infrastructure (#56)
* feat(agents): implement category-based agent organization system

- Organize agents into domain categories (core, development, content, data, product, learning)
- Move 10 agents to category subdirectories with proper git rename tracking
- Update 13 subagents with category and type metadata in frontmatter
- Add category metadata files (0-category.json) documenting common patterns
- Implement local registry fallback in install script for offline development
- Add comprehensive validation suite with 15 automated tests (100% pass rate)
- Enhance registry validation with duplicate ID and consistency checks
- Update eval framework with intelligent path resolution (backward compatible)
- Archive legacy eval structure to _archive/ for reference
- Update all documentation to reflect category-based structure
- Bump version to 0.5.0 with accurate CHANGELOG

Technical Details:
- 23 agents organized (10 category agents, 13 subagents)
- 6 category directories created
- Path resolution supports both agent IDs and category paths
- Registry schema updated to v2.0.0
- 159 files changed, 872 insertions(+), 10738 deletions(-)

BREAKING CHANGE: Agent file paths now use category structure. Update references from .opencode/agent/openagent.md to .opencode/agent/core/openagent.md. Eval framework maintains backward compatibility via path resolution.

* refactor(evals): consolidate documentation and enhance test infrastructure

- Remove temporary project tracking files (PHASE_5_COMPLETE, PROJECT_COMPLETE, etc.)
- Consolidate evaluation framework docs into main README
- Enhance test execution with improved logging and multi-prompt support
- Move system-builder from core to meta category
- Add comprehensive test suites for openagent with organized structure
- Create evaluation test structure for all subagents
- Clean up archived workflows and redundant documentation
- Update registry to reflect new agent organization
- Add shared test templates and golden test patterns

* feat(ci): add manual trigger support for bot-created PRs in validate-registry workflow

- Add pr_number input to workflow_dispatch for manually triggering validation
- Fetch PR details dynamically when triggered manually
- Support both automatic (PR event) and manual (workflow_dispatch) triggers
- Enable validation of bot-created PRs like automated version bumps
- Update branch detection and push logic to handle both trigger types
- Add documentation explaining how to manually trigger for bot PRs

* feat(evals): add explicit context file validation to test framework

- Add expectedContextFiles field to test YAML schema for explicit context file specification
- Enhance context-loading-evaluator to support both auto-detect and explicit validation modes
- Update documentation with comprehensive guide and examples
- Clean up archived legacy test structure (90+ old test files)
- Add new example tests demonstrating explicit context validation
- Backward compatible with existing tests

* feat(evals): add multi-agent logging system and performance optimizations

Implement comprehensive multi-agent logging and performance improvements for the eval framework.

Task 01: Multi-Agent Logging System
- Add complete hierarchical logging module (evals/framework/src/logging/)
  - SessionTracker: tracks parent-child delegation hierarchies
  - MultiAgentLogger: pretty-prints logs with visual indentation
  - Formatters: box characters and emoji formatting
  - 37 passing unit tests (session-tracker, logger, integration)
- Integrate with SDK event stream handler
  - Hook into session.created, message.updated, message.part.updated events
  - Real-time child session detection via timestamp heuristics
  - Message deduplication for cleaner output
- Enable in debug mode only (<1% performance overhead)
- Add demo script and comprehensive documentation

Task 02: Performance Optimizations
- Reduce grace period from 5s to 2s (67% reduction, 10-20% faster tests)
- Add PerformanceMetricsEvaluator for bottleneck identification
  - Collects tool latencies, inference time, idle time
  - Provides full performance visibility
- Update smoke test to validate delegation (core feature)
  - Replace simple read test with multi-agent delegation test
  - Tests both parent and child agent functionality
  - Validates multi-agent logging system

Results:
- 37 unit tests passing
- Smoke test passing (95/100 score)
- Clean hierarchical logging output
- 10-20% faster test execution
- Full multi-agent visibility

Files changed: 16 files, +2678 lines
Time saved: ~6-8 days (completed in 6 hours vs 3-5 day estimate)

* feat(evals): show child agent execution in non-debug mode

- Enable MultiAgentLogger in both debug and non-debug modes
- Add verbose parameter to control output level
- Non-verbose mode shows concise child session lifecycle:
  - Child agent started message
  - Child agent completed with duration
- Verbose mode (--debug) shows full delegation hierarchy
- Update documentation to reflect new behavior

This provides visibility into delegation without overwhelming output,
giving confidence that child agents are actually running.

* feat(evals): improve delegation testing and behavior validation

Major improvements to eval framework:

Test Suite:
- Add 00-smoke-test.yaml (basic read operation)
- Rename 01-smoke-test.yaml → 02-delegation-test.yaml (delegation test)
- Add simple-responder test agent for delegation testing
- Add debug test: simple-subagent-call.yaml

Evaluators:
- Add agent-model-evaluator.ts for agent/model validation
- Enhance behavior-evaluator.ts with detailed task tool output
- Improve delegation-evaluator.ts with better evidence tracking

Schema & Execution:
- Add expectedAgent and expectedModel to test schema
- Improve test executor with better logging and error handling

Documentation:
- Update evals/README.md with new features and performance improvements
- Remove outdated MULTI_AGENT_LOGGING_COMPLETE.md

Registry:
- Add simple-responder test agent to registry

Fixes:
- Fix dashboard.sh path resolution

These changes provide better visibility into delegation, improved test
coverage, and clearer validation of agent behavior.

* chore: add GitHub Actions workflow and plugin documentation

- Add .github/workflows/evals/run-evaluations.yml for automated eval testing
- Add dev/ai-tools/opencode/plugins/Plugin-inspiration.md for plugin development reference
2025-12-18 09:52:11 +00:00

387 lines
6.1 KiB
Markdown

# Lookup: Command Reference
**Purpose**: Quick reference for common commands
---
## Registry Commands
### Validate Registry
```bash
# Basic validation
./scripts/registry/validate-registry.sh
# Verbose output
./scripts/registry/validate-registry.sh -v
```
### Auto-Detect Components
```bash
# Dry run (see what would change)
./scripts/registry/auto-detect-components.sh --dry-run
# Add new components
./scripts/registry/auto-detect-components.sh --auto-add
# Force update existing
./scripts/registry/auto-detect-components.sh --auto-add --force
```
### Validate Component Structure
```bash
./scripts/registry/validate-component.sh
```
---
## Testing Commands
### Run Tests
```bash
# Single test
cd evals/framework
npm run eval:sdk -- --agent={category}/{agent} --pattern="{test}.yaml"
# All tests for agent
npm run eval:sdk -- --agent={category}/{agent}
# All tests (all agents)
npm run eval:sdk
# With debug
npm run eval:sdk -- --agent={agent} --debug
```
### Validate Test Suites
```bash
./scripts/validation/validate-test-suites.sh
```
---
## Installation Commands
### Install Components
```bash
# List available components
./install.sh --list
# Install profile
./install.sh {profile}
# Profiles: essential, developer, business
# Install specific component
./install.sh --component agent:{agent-name}
# Test with local registry
REGISTRY_URL="file://$(pwd)/registry.json" ./install.sh --list
```
### Collision Handling
```bash
# Skip existing files
./install.sh developer --skip-existing
# Overwrite all
./install.sh developer --force
# Backup existing
./install.sh developer --backup
```
---
## Version Commands
### Check Version
```bash
# Check all version files
cat VERSION
cat package.json | jq '.version'
cat registry.json | jq '.version'
```
### Update Version
```bash
# Update VERSION
echo "0.X.Y" > VERSION
# Update package.json
jq '.version = "0.X.Y"' package.json > tmp && mv tmp package.json
# Update registry.json
jq '.version = "0.X.Y"' registry.json > tmp && mv tmp registry.json
```
### Bump Version Script
```bash
./scripts/versioning/bump-version.sh 0.X.Y
```
---
## Git Commands
### Create Release
```bash
# Commit version changes
git add VERSION package.json CHANGELOG.md
git commit -m "chore: bump version to 0.X.Y"
# Create tag
git tag -a v0.X.Y -m "Release v0.X.Y"
# Push
git push origin main
git push origin v0.X.Y
```
### Create GitHub Release
```bash
# Via GitHub CLI
gh release create v0.X.Y \
--title "v0.X.Y" \
--notes "See CHANGELOG.md for details"
```
---
## Validation Commands
### Full Validation
```bash
# Validate everything
./scripts/registry/validate-registry.sh && \
./scripts/validation/validate-test-suites.sh && \
cd evals/framework && npm run eval:sdk
```
### Validate Context References
```bash
./scripts/validation/validate-context-refs.sh
```
### Setup Pre-Commit Hook
```bash
./scripts/validation/setup-pre-commit-hook.sh
```
---
## Development Commands
### Run Demo
```bash
./scripts/development/demo.sh
```
### Run Dashboard
```bash
./scripts/development/dashboard.sh
```
---
## Maintenance Commands
### Cleanup Stale Sessions
```bash
./scripts/maintenance/cleanup-stale-sessions.sh
```
### Uninstall
```bash
./scripts/maintenance/uninstall.sh
```
---
## Debugging Commands
### Check Sessions
```bash
# List recent sessions
ls -lt .tmp/sessions/ | head -5
# View session
cat .tmp/sessions/{session-id}/session.json | jq
# View events
cat .tmp/sessions/{session-id}/events.json | jq
```
### Check Context Logs
```bash
# Check session cache
./scripts/check-context-logs/check-session-cache.sh
# Count agent tokens
./scripts/check-context-logs/count-agent-tokens.sh
# Show API payload
./scripts/check-context-logs/show-api-payload.sh
# Show cached data
./scripts/check-context-logs/show-cached-data.sh
```
---
## Quick Workflows
### Adding a New Agent
```bash
# 1. Create agent file
touch .opencode/agent/{category}/{agent-name}.md
# (Add frontmatter and content)
# 2. Create test structure
mkdir -p evals/agents/{category}/{agent-name}/{config,tests}
# (Create config.yaml and smoke-test.yaml)
# 3. Update registry
./scripts/registry/auto-detect-components.sh --auto-add
# 4. Validate
./scripts/registry/validate-registry.sh
cd evals/framework && npm run eval:sdk -- --agent={category}/{agent-name}
```
### Testing an Agent
```bash
# 1. Run smoke test
cd evals/framework
npm run eval:sdk -- --agent={category}/{agent} --pattern="smoke-test.yaml"
# 2. If fails, debug
npm run eval:sdk -- --agent={category}/{agent} --debug
# 3. Check session
ls -lt .tmp/sessions/ | head -1
cat .tmp/sessions/{session-id}/session.json | jq
```
### Creating a Release
```bash
# 1. Update version
echo "0.X.Y" > VERSION
jq '.version = "0.X.Y"' package.json > tmp && mv tmp package.json
# 2. Update CHANGELOG
# (Edit CHANGELOG.md)
# 3. Commit and tag
git add VERSION package.json CHANGELOG.md
git commit -m "chore: bump version to 0.X.Y"
git tag -a v0.X.Y -m "Release v0.X.Y"
# 4. Push
git push origin main
git push origin v0.X.Y
# 5. Create GitHub release
gh release create v0.X.Y --title "v0.X.Y" --notes "See CHANGELOG.md"
```
---
## Common Patterns
### Find Files
```bash
# Find agent
find .opencode/agent -name "{agent-name}.md"
# Find tests
find evals/agents -name "*.yaml"
# Find context
find .opencode/context -name "*.md"
# Find scripts
find scripts -name "*.sh"
```
### Check Registry
```bash
# List all agents
cat registry.json | jq '.components.agents[].id'
# Check specific component
cat registry.json | jq '.components.agents[] | select(.id == "{agent-name}")'
# Count components
cat registry.json | jq '.components.agents | length'
```
### Test Locally
```bash
# Test with local registry
REGISTRY_URL="file://$(pwd)/registry.json" ./install.sh --list
# Install locally
REGISTRY_URL="file://$(pwd)/registry.json" ./install.sh developer
```
---
## NPM Commands (Eval Framework)
```bash
cd evals/framework
# Install dependencies
npm install
# Run tests
npm test
# Run eval SDK
npm run eval:sdk
# Build
npm run build
# Lint
npm run lint
```
---
## Related Files
- **Quick start**: `quick-start.md`
- **File locations**: `lookup/file-locations.md`
- **Guides**: `guides/`
---
**Last Updated**: 2025-12-10
**Version**: 0.5.0