cclohmar/OpenWriterControle
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
OpenWriterControle/QUICK_START.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

303 lines
7.9 KiB
Markdown
Raw Blame History

# 🚀 OpenCode Agents - Quick Start
![Version](https://img.shields.io/badge/version-0.1.0--alpha.1-blue)
## 📋 Available Agents
- **openagent** - Full-featured development agent (22+ tests)
- Developer tests: Code, docs, tests, delegation
- Context loading tests: Standards, patterns, workflows
- Business tests: Conversations, data analysis
- Edge cases: Approval gates, negative tests
- **opencoder** - Specialized coding agent (4+ tests)
- Developer tests: Bash execution, file operations
- Multi-tool workflows
---
## 🧪 Running Tests
### Test All Agents
```bash
npm test # All agents, all tests (default)
npm run test:all # Explicit all agents
```
### Test Specific Agent
```bash
npm run test:openagent # OpenAgent only
npm run test:opencoder # OpenCoder only
```
### Test with Different Models
#### OpenAgent
```bash
npm run test:openagent:grok # Grok (free tier, fast)
npm run test:openagent:claude # Claude Sonnet 4.5 (best quality)
npm run test:openagent:gpt4 # GPT-4 Turbo (OpenAI)
```
#### OpenCoder
```bash
npm run test:opencoder:grok # Grok (free tier, fast)
npm run test:opencoder:claude # Claude Sonnet 4.5 (best quality)
npm run test:opencoder:gpt4 # GPT-4 Turbo (OpenAI)
```
#### All Agents
```bash
npm run test:all:grok # All agents with Grok
npm run test:all:claude # All agents with Claude
npm run test:all:gpt4 # All agents with GPT-4
```
---
## 🎯 Test Specific Categories
### OpenAgent Categories
```bash
npm run test:openagent:developer # Developer tests (code, docs, tests)
npm run test:openagent:context # Context loading tests
npm run test:openagent:business # Business/conversation tests
```
### OpenCoder Categories
```bash
npm run test:opencoder:developer # Developer tests
npm run test:opencoder:bash # Bash execution tests
```
### Custom Patterns
```bash
npm run test:pattern -- "developer/*.yaml" # All developer tests
npm run test:pattern -- "context-loading/*.yaml" # Context tests
npm run test:pattern -- "edge-case/*.yaml" # Edge cases
npm run test:openagent -- --pattern="developer/ctx-*" # OpenAgent context tests
```
---
## 📊 View Results
### Dashboard (Recommended)
```bash
npm run dashboard # Launch interactive dashboard
npm run dashboard:open # Launch and auto-open browser
```
The dashboard provides:
- ✅ Real-time test results visualization
- ✅ Filter by agent, category, status
- ✅ Detailed violation tracking
- ✅ CSV export functionality
- ✅ Historical results tracking
### Command Line
```bash
npm run results:openagent # Recent OpenAgent results
npm run results:opencoder # Recent OpenCoder results
npm run results:latest # Latest test summary (JSON)
```
---
## 🐛 Debug Mode
```bash
npm run test:debug # Run with debug output
npm run test:openagent -- --debug # Debug OpenAgent tests
npm run test:opencoder -- --debug # Debug OpenCoder tests
```
Debug mode shows:
- Detailed event logging
- Tool call details
- Session information
- Evaluation progress
---
## 🔧 Development
```bash
npm run dev:setup # Install dependencies
npm run dev:build # Build framework
npm run dev:test # Run unit tests
npm run dev:clean # Clean and reinstall
```
---
## 📈 Version Management
```bash
npm run version # Show current version
npm run version:bump alpha # Bump alpha version
npm run version:bump beta # Bump to beta
npm run version:bump rc # Bump to release candidate
```
---
## 📁 Test Structure
```
evals/agents/
├── openagent/tests/
│ ├── developer/ # Code, docs, tests (12 tests)
│ │ ├── ctx-code-001.yaml
│ │ ├── ctx-docs-001.yaml
│ │ ├── ctx-tests-001.yaml
│ │ ├── ctx-delegation-001.yaml
│ │ └── ...
│ ├── context-loading/ # Context loading (5 tests)
│ │ ├── ctx-simple-coding-standards.yaml
│ │ ├── ctx-simple-documentation-format.yaml
│ │ └── ...
│ ├── business/ # Conversations (2 tests)
│ │ ├── conv-simple-001.yaml
│ │ └── data-analysis.yaml
│ └── edge-case/ # Edge cases (3 tests)
│ ├── just-do-it.yaml
│ ├── missing-approval-negative.yaml
│ └── no-approval-negative.yaml
│
└── opencoder/tests/
└── developer/ # Bash, file ops (4 tests)
├── bash-execution-001.yaml
├── file-read-001.yaml
├── multi-tool-001.yaml
└── simple-bash-test.yaml
```
---
## 💡 Common Workflows
### Quick Test (Free Tier)
```bash
npm run test:openagent:grok # Fast, free
npm run test:opencoder:grok # Fast, free
```
### Quality Test (Best Model)
```bash
npm run test:openagent:claude # Best quality
npm run test:opencoder:claude # Best quality
```
### Full Test Suite
```bash
npm run test:all:claude # All agents, best model
```
### Continuous Development
```bash
# 1. Run tests in debug mode
npm run test:openagent:developer -- --debug
# 2. View results in dashboard
npm run dashboard:open
# 3. Iterate on agent prompts
# Edit .opencode/agent/core/openagent.md
# 4. Re-run tests
npm run test:openagent:developer
```
### CI/CD Smoke Tests
```bash
npm run test:ci # Fast smoke tests for both agents
npm run test:ci:openagent # OpenAgent smoke test
npm run test:ci:opencoder # OpenCoder smoke test
```
---
## 🎯 Test Results
After running tests, results are saved to:
- `evals/results/latest.json` - Latest test run
- `evals/results/history/YYYY-MM/DD-HHMMSS-{agent}.json` - Historical results
View in dashboard: `npm run dashboard:open`
---
## 🔍 Understanding Test Results
### Test Status
- ✅ **PASSED** - All checks passed, no violations
- ❌ **FAILED** - Test failed (execution error or violations)
### Evaluators
Tests are evaluated by multiple evaluators:
- **approval-gate** - Checks if agent requested approval when required
- **context-loading** - Validates context files were loaded before execution
- **delegation** - Checks if agent delegated to subagents appropriately
- **tool-usage** - Validates correct tool usage
- **behavior** - Checks if agent performed expected actions
### Violations
- **Error** - Critical issues that cause test failure
- **Warning** - Non-critical issues
- **Info** - Informational messages
---
## 📚 Additional Resources
- [README.md](README.md) - Project overview
- [evals/GETTING_STARTED.md](evals/GETTING_STARTED.md) - Detailed evaluation guide
- [evals/ARCHITECTURE.md](evals/ARCHITECTURE.md) - System architecture
- [evals/framework/SDK_EVAL_README.md](evals/framework/SDK_EVAL_README.md) - SDK documentation
- [CHANGELOG.md](CHANGELOG.md) - Version history
---
## 🆘 Troubleshooting
### Tests not running?
```bash
# Ensure dependencies are installed
npm run dev:setup
# Build the framework
npm run dev:build
```
### Dashboard not loading?
```bash
# Check if results exist
ls -la evals/results/
# Try launching manually
cd evals/results && ./serve.sh
```
### Version mismatch?
```bash
# Check current version
npm run version
# Sync VERSION file with package.json
npm run version > VERSION
```
---
## 🎉 Getting Help
- Check [evals/GETTING_STARTED.md](evals/GETTING_STARTED.md) for detailed guides
- Review test examples in `evals/agents/*/tests/`
- Run tests in debug mode: `npm run test:debug`
- View results dashboard: `npm run dashboard:open`
---
**Current Version:** 0.1.0-alpha.1
**Last Updated:** 2025-11-26
Reference in a new issue View git blame Copy permalink