mirror of
https://github.com/proffesor-for-testing/agentic-qe.git
synced 2026-09-19 08:45:47 +08:00
5a2883a4a0
Agentic Quality Engineering Fleet - AI-driven quality management platform Features: - 16 specialized QE agents for comprehensive testing - AI-powered test generation with 95% coverage targets - O(log n) sublinear algorithms for massive scale - Parallel test execution with intelligent orchestration - Real-time coverage analysis and gap detection - Smart quality gates with ML-driven decisions - Security scanning (SAST, DAST, dependency analysis) - Performance testing with load orchestration - Flaky test detection with automatic stabilization - API contract validation with breaking change detection - Test data generation (10,000+ records/sec) - Production intelligence (convert incidents to tests) - Chaos engineering for resilience testing - MCP integration with Claude Code - Multi-framework support (Jest, Mocha, Cypress, Playwright) Architecture: - TypeScript implementation - MCP (Model Context Protocol) integration - Claude Code agent orchestration - Event-driven agent coordination - Distributed fleet management - Cross-session memory persistence Documentation: - Complete API documentation (TypeDoc) - User guides (Getting Started, MCP Integration, Test Generation, etc.) - Architecture deep-dive - CLI reference - Contributing guidelines - MIT License Tech Stack: - TypeScript 5.3+ - Node.js 18+ - @anthropic-ai/sdk ^0.64.0 - @modelcontextprotocol/sdk ^1.18.2 - Jest for testing - Winston for logging - SQLite for persistence Project Structure: - src/ - Source code (agents, core, MCP, CLI) - tests/ - Comprehensive test suite - docs/ - Complete documentation - .claude/ - Agent definitions and commands - config/ - Configuration files 🤖 Generated with Claude Code https://claude.com/claude-code Co-Authored-By: Claude <noreply@anthropic.com>
391 lines
56 KiB
HTML
391 lines
56 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Agentic QE Fleet API Documentation - v1.0.0</title><meta name="description" content="Documentation for Agentic QE Fleet API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/your-org/agentic-qe-fleet">GitHub</a><a href="https://github.com/your-org/agentic-qe-fleet#readme">Documentation</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Agentic QE Fleet API Documentation - v1.0.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>Agentic QE Fleet API Documentation - v1.0.0</h2></div><div class="tsd-panel tsd-typography"><a id="md:agentic-quality-engineering-fleet" class="tsd-anchor"></a><h1><a href="#md:agentic-quality-engineering-fleet">Agentic Quality Engineering Fleet</a></h1><div align="center">
|
|
|
|
<p><a href="https://www.npmjs.com/package/agentic-qe"><img src="https://img.shields.io/npm/v/agentic-qe.svg" alt="npm version"></a>
|
|
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
|
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-5.0+-blue.svg" alt="TypeScript"></a>
|
|
<a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node.js-18+-green.svg" alt="Node.js"></a></p>
|
|
<p><strong>AI-Driven Quality Engineering Automation</strong></p>
|
|
<p>A distributed fleet of specialized AI agents for comprehensive software testing, quality assurance, and continuous validation.</p>
|
|
<p><a href="#md:quick-start">Quick Start</a> • <a href="docs/">Documentation</a> • <a href="CONTRIBUTING.md">Contributing</a> • <a href="examples/">Examples</a></p>
|
|
</div>
|
|
|
|
<hr>
|
|
<a id="md:🚀-features" class="tsd-anchor"></a><h2><a href="#md:🚀-features">🚀 Features</a></h2><a id="md:autonomous-agent-fleet" class="tsd-anchor"></a><h3><a href="#md:autonomous-agent-fleet">Autonomous Agent Fleet</a></h3><ul>
|
|
<li><strong>16 Specialized QE Agents</strong>: Each agent is an expert in specific quality engineering domains</li>
|
|
<li><strong>Intelligent Coordination</strong>: Event-driven architecture with automatic task distribution</li>
|
|
<li><strong>Scalable</strong>: From single developer projects to enterprise-scale testing infrastructure</li>
|
|
<li><strong>Self-Organizing</strong>: Agents autonomously coordinate testing strategies</li>
|
|
</ul>
|
|
<a id="md:comprehensive-testing" class="tsd-anchor"></a><h3><a href="#md:comprehensive-testing">Comprehensive Testing</a></h3><ul>
|
|
<li><strong>AI-Powered Test Generation</strong>: Generate comprehensive test suites automatically</li>
|
|
<li><strong>Multi-Framework Support</strong>: Jest, Mocha, Cypress, Playwright, and more</li>
|
|
<li><strong>Parallel Execution</strong>: Execute thousands of tests concurrently with intelligent orchestration</li>
|
|
<li><strong>Real-Time Coverage Analysis</strong>: O(log n) algorithms for instant coverage gap detection</li>
|
|
</ul>
|
|
<a id="md:quality-intelligence" class="tsd-anchor"></a><h3><a href="#md:quality-intelligence">Quality Intelligence</a></h3><ul>
|
|
<li><strong>Smart Quality Gates</strong>: ML-driven quality assessment with risk scoring</li>
|
|
<li><strong>Security Scanning</strong>: SAST, DAST, dependency analysis, and container security</li>
|
|
<li><strong>Performance Testing</strong>: Load testing with k6, JMeter, and Gatling integration</li>
|
|
<li><strong>Visual Regression</strong>: AI-powered screenshot comparison and UI validation</li>
|
|
</ul>
|
|
<a id="md:advanced-capabilities" class="tsd-anchor"></a><h3><a href="#md:advanced-capabilities">Advanced Capabilities</a></h3><ul>
|
|
<li><strong>Flaky Test Detection</strong>: Statistical analysis with automatic stabilization</li>
|
|
<li><strong>API Contract Validation</strong>: Breaking change detection across versions</li>
|
|
<li><strong>Test Data Generation</strong>: 10,000+ realistic records per second</li>
|
|
<li><strong>Production Intelligence</strong>: Convert production incidents into test scenarios</li>
|
|
<li><strong>Chaos Engineering</strong>: Controlled fault injection for resilience testing</li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:📦-prerequisites-amp-installation" class="tsd-anchor"></a><h2><a href="#md:📦-prerequisites-amp-installation">📦 Prerequisites & Installation</a></h2><a id="md:prerequisites" class="tsd-anchor"></a><h3><a href="#md:prerequisites">Prerequisites</a></h3><p>Before using Agentic QE, you must have:</p>
|
|
<a id="md:required" class="tsd-anchor"></a><h4><a href="#md:required">Required</a></h4><ul>
|
|
<li><strong>Claude Code</strong>: Install from <a href="https://claude.ai/code">claude.ai/code</a></li>
|
|
<li><strong>Node.js</strong>: 18.0 or higher</li>
|
|
<li><strong>npm</strong>: 8.0 or higher</li>
|
|
</ul>
|
|
<a id="md:optional-advanced-features" class="tsd-anchor"></a><h4><a href="#md:optional-advanced-features">Optional (Advanced Features)</a></h4><ul>
|
|
<li><strong>Claude Flow</strong>: For advanced coordination<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-6">-g</span><span class="hl-1"> </span><span class="hl-2">@claude/flow</span><br/><span class="hl-5"># or</span><br/><span class="hl-0">npx</span><span class="hl-1"> </span><span class="hl-2">claude-flow@alpha</span><span class="hl-1"> </span><span class="hl-2">init</span><span class="hl-1"> </span><span class="hl-6">--force</span>
|
|
</code><button>Copy</button></pre>
|
|
</li>
|
|
</ul>
|
|
<a id="md:installation-steps" class="tsd-anchor"></a><h3><a href="#md:installation-steps">Installation Steps</a></h3><ol>
|
|
<li><p><strong>Install Claude Code</strong> globally or in your workspace</p>
|
|
</li>
|
|
<li><p><strong>Global Installation</strong> (Recommended)</p>
|
|
<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-6">-g</span><span class="hl-1"> </span><span class="hl-2">agentic-qe</span>
|
|
</code><button>Copy</button></pre>
|
|
</li>
|
|
<li><p><strong>Local Development</strong></p>
|
|
<pre><code class="language-bash"><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-2">clone</span><span class="hl-1"> </span><span class="hl-2">https://github.com/proffesor-for-testing/agentic-qe.git</span><br/><span class="hl-0">cd</span><span class="hl-1"> </span><span class="hl-2">agentic-qe</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">build</span>
|
|
</code><button>Copy</button></pre>
|
|
</li>
|
|
</ol>
|
|
<a id="md:system-requirements" class="tsd-anchor"></a><h3><a href="#md:system-requirements">System Requirements</a></h3><ul>
|
|
<li><strong>Memory</strong>: 2GB+ recommended for large test suites</li>
|
|
<li><strong>OS</strong>: Linux, macOS, Windows (via WSL2)</li>
|
|
<li><strong>Agent Execution</strong>: Via Claude Code's Task tool or MCP integration</li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:⚡-quick-start" class="tsd-anchor"></a><h2><a href="#md:⚡-quick-start">⚡ Quick Start</a></h2><a id="md:initialize-your-project" class="tsd-anchor"></a><h3><a href="#md:initialize-your-project">Initialize Your Project</a></h3><pre><code class="language-bash"><span class="hl-5"># Initialize AQE Fleet in your project</span><br/><span class="hl-0">aqe</span><span class="hl-1"> </span><span class="hl-2">init</span>
|
|
</code><button>Copy</button></pre>
|
|
<p><strong>What it does:</strong></p>
|
|
<ul>
|
|
<li>Creates <code>.claude/agents/</code> with 16 specialized QE agent definitions</li>
|
|
<li>Creates <code>.claude/commands/</code> with 8 AQE slash commands</li>
|
|
<li>Creates <code>.agentic-qe/</code> configuration directory</li>
|
|
<li>Updates or creates <code>CLAUDE.md</code> with integration documentation</li>
|
|
<li><strong>Note</strong>: Agents are executed through Claude Code's Task tool, not as standalone processes</li>
|
|
</ul>
|
|
<p><strong>Agent Execution Model:</strong></p>
|
|
<ul>
|
|
<li>Agents are Claude Code agent definitions (markdown files in <code>.claude/agents/</code>)</li>
|
|
<li>Executed via Claude Code's Task tool: <code>Task("description", "prompt", "agent-type")</code></li>
|
|
<li>NOT standalone Node.js processes</li>
|
|
<li>Integration with Claude Code via MCP (Model Context Protocol)</li>
|
|
</ul>
|
|
<a id="md:basic-commands" class="tsd-anchor"></a><h3><a href="#md:basic-commands">Basic Commands</a></h3><pre><code class="language-bash"><span class="hl-5"># Check fleet status</span><br/><span class="hl-0">aqe</span><span class="hl-1"> </span><span class="hl-2">status</span><br/><br/><span class="hl-5"># Generate tests for a module</span><br/><span class="hl-0">aqe</span><span class="hl-1"> </span><span class="hl-2">test</span><span class="hl-1"> </span><span class="hl-2">src/services/user-service.ts</span><br/><br/><span class="hl-5"># Analyze test coverage</span><br/><span class="hl-0">aqe</span><span class="hl-1"> </span><span class="hl-2">coverage</span><span class="hl-1"> </span><span class="hl-6">--threshold</span><span class="hl-1"> </span><span class="hl-8">95</span><br/><br/><span class="hl-5"># Run quality gate validation</span><br/><span class="hl-0">aqe</span><span class="hl-1"> </span><span class="hl-2">quality</span><br/><br/><span class="hl-5"># Execute comprehensive test suite</span><br/><span class="hl-0">aqe</span><span class="hl-1"> </span><span class="hl-2">execute</span><span class="hl-1"> </span><span class="hl-6">--parallel</span><span class="hl-1"> </span><span class="hl-6">--coverage</span><br/><br/><span class="hl-5"># View all commands</span><br/><span class="hl-0">aqe</span><span class="hl-1"> </span><span class="hl-2">help</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:programmatic-usage" class="tsd-anchor"></a><h3><a href="#md:programmatic-usage">Programmatic Usage</a></h3><pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">FleetManager</span><span class="hl-1">, </span><span class="hl-4">QEAgentFactory</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'agentic-qe'</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// Initialize fleet</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">fleet</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">FleetManager</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">maxAgents:</span><span class="hl-1"> </span><span class="hl-8">20</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">topology:</span><span class="hl-1"> </span><span class="hl-2">'mesh'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">fleet</span><span class="hl-1">.</span><span class="hl-0">initialize</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// Spawn test generator agent</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">testGen</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">fleet</span><span class="hl-1">.</span><span class="hl-0">spawnAgent</span><span class="hl-1">(</span><span class="hl-2">'test-generator'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">targetCoverage:</span><span class="hl-1"> </span><span class="hl-8">95</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">framework:</span><span class="hl-1"> </span><span class="hl-2">'jest'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// Generate tests for a module</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">tests</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">testGen</span><span class="hl-1">.</span><span class="hl-0">execute</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">sourceFile:</span><span class="hl-1"> </span><span class="hl-2">'src/services/user-service.ts'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">testStyle:</span><span class="hl-1"> </span><span class="hl-2">'property-based'</span><br/><span class="hl-1">});</span>
|
|
</code><button>Copy</button></pre>
|
|
<hr>
|
|
<a id="md:🤖-agent-types" class="tsd-anchor"></a><h2><a href="#md:🤖-agent-types">🤖 Agent Types</a></h2><a id="md:core-testing-agents" class="tsd-anchor"></a><h3><a href="#md:core-testing-agents">Core Testing Agents</a></h3><table>
|
|
<thead>
|
|
<tr>
|
|
<th>Agent</th>
|
|
<th>Purpose</th>
|
|
<th>Key Features</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><strong>test-generator</strong></td>
|
|
<td>AI-powered test creation</td>
|
|
<td>Property-based testing, edge case detection</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>test-executor</strong></td>
|
|
<td>Multi-framework execution</td>
|
|
<td>Parallel processing, retry logic, reporting</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>coverage-analyzer</strong></td>
|
|
<td>Real-time gap analysis</td>
|
|
<td>O(log n) algorithms, trend tracking</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>quality-gate</strong></td>
|
|
<td>Intelligent validation</td>
|
|
<td>ML-driven decisions, risk assessment</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>quality-analyzer</strong></td>
|
|
<td>Metrics analysis</td>
|
|
<td>ESLint, SonarQube, Lighthouse integration</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<a id="md:performance-amp-security" class="tsd-anchor"></a><h3><a href="#md:performance-amp-security">Performance & Security</a></h3><table>
|
|
<thead>
|
|
<tr>
|
|
<th>Agent</th>
|
|
<th>Purpose</th>
|
|
<th>Key Features</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><strong>performance-tester</strong></td>
|
|
<td>Load & stress testing</td>
|
|
<td>k6, JMeter, Gatling, bottleneck detection</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>security-scanner</strong></td>
|
|
<td>Vulnerability detection</td>
|
|
<td>SAST, DAST, dependency scanning</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<a id="md:strategic-planning" class="tsd-anchor"></a><h3><a href="#md:strategic-planning">Strategic Planning</a></h3><table>
|
|
<thead>
|
|
<tr>
|
|
<th>Agent</th>
|
|
<th>Purpose</th>
|
|
<th>Key Features</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><strong>requirements-validator</strong></td>
|
|
<td>Testability analysis</td>
|
|
<td>INVEST criteria, BDD generation</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>production-intelligence</strong></td>
|
|
<td>Incident replay</td>
|
|
<td>RUM analysis, anomaly detection</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>fleet-commander</strong></td>
|
|
<td>Hierarchical coordination</td>
|
|
<td>50+ agent orchestration</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<a id="md:advanced-testing" class="tsd-anchor"></a><h3><a href="#md:advanced-testing">Advanced Testing</a></h3><table>
|
|
<thead>
|
|
<tr>
|
|
<th>Agent</th>
|
|
<th>Purpose</th>
|
|
<th>Key Features</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><strong>regression-risk-analyzer</strong></td>
|
|
<td>Smart test selection</td>
|
|
<td>ML patterns, AST analysis</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>test-data-architect</strong></td>
|
|
<td>Realistic data generation</td>
|
|
<td>10k+ records/sec, GDPR compliant</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>api-contract-validator</strong></td>
|
|
<td>Breaking change detection</td>
|
|
<td>OpenAPI, GraphQL, gRPC</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>flaky-test-hunter</strong></td>
|
|
<td>Stability analysis</td>
|
|
<td>Statistical detection, auto-fix</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<a id="md:specialized" class="tsd-anchor"></a><h3><a href="#md:specialized">Specialized</a></h3><table>
|
|
<thead>
|
|
<tr>
|
|
<th>Agent</th>
|
|
<th>Purpose</th>
|
|
<th>Key Features</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><strong>deployment-readiness</strong></td>
|
|
<td>Release validation</td>
|
|
<td>Multi-factor risk scoring</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>visual-tester</strong></td>
|
|
<td>UI regression</td>
|
|
<td>AI-powered comparison</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>chaos-engineer</strong></td>
|
|
<td>Resilience testing</td>
|
|
<td>Fault injection, blast radius</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<hr>
|
|
<a id="md:🏗️-architecture" class="tsd-anchor"></a><h2><a href="#md:🏗️-architecture">🏗️ Architecture</a></h2><a id="md:core-components" class="tsd-anchor"></a><h3><a href="#md:core-components">Core Components</a></h3><pre><code><span class="hl-1">┌─────────────────────────────────────────────┐</span><br/><span class="hl-1">│ </span><span class="hl-4">Fleet</span><span class="hl-1"> </span><span class="hl-4">Manager</span><span class="hl-1"> │</span><br/><span class="hl-1">│ (</span><span class="hl-4">Central</span><span class="hl-1"> </span><span class="hl-4">Coordination</span><span class="hl-1"> & </span><span class="hl-4">Task</span><span class="hl-1"> </span><span class="hl-4">Distribution</span><span class="hl-1">) │</span><br/><span class="hl-1">└─────────────────────────────────────────────┘</span><br/><span class="hl-1"> │</span><br/><span class="hl-1"> ┌───────────┼───────────┐</span><br/><span class="hl-1"> │ │ │</span><br/><span class="hl-1"> ┌────▼────┐ ┌───▼────┐ ┌───▼────┐</span><br/><span class="hl-1"> │ </span><span class="hl-4">Agent</span><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1"> │ │ </span><span class="hl-4">Agent</span><span class="hl-1"> </span><span class="hl-8">2</span><span class="hl-1">│ │ </span><span class="hl-4">Agent</span><span class="hl-1"> </span><span class="hl-7">N</span><span class="hl-1">│</span><br/><span class="hl-1"> │ </span><span class="hl-4">Pool</span><span class="hl-1"> │ │ </span><span class="hl-4">Pool</span><span class="hl-1"> │ │ </span><span class="hl-4">Pool</span><span class="hl-1"> │</span><br/><span class="hl-1"> └────┬────┘ └───┬────┘ └───┬────┘</span><br/><span class="hl-1"> │ │ │</span><br/><span class="hl-1"> ┌────▼──────────▼──────────▼────┐</span><br/><span class="hl-1"> │ </span><span class="hl-4">Event</span><span class="hl-1"> </span><span class="hl-4">Bus</span><span class="hl-1"> │</span><br/><span class="hl-1"> │ (</span><span class="hl-4">Event</span><span class="hl-1">-</span><span class="hl-4">Driven</span><span class="hl-1"> </span><span class="hl-4">Communication</span><span class="hl-1">) │</span><br/><span class="hl-1"> └────┬──────────────────────┬────┘</span><br/><span class="hl-1"> │ │</span><br/><span class="hl-1"> ┌────▼────┐ ┌────▼────┐</span><br/><span class="hl-1"> │ </span><span class="hl-4">Memory</span><span class="hl-1"> │ │</span><span class="hl-4">Database</span><span class="hl-1"> │</span><br/><span class="hl-1"> │ </span><span class="hl-4">Store</span><span class="hl-1"> │ │(</span><span class="hl-4">SQLite</span><span class="hl-1">) │</span><br/><span class="hl-1"> └─────────┘ └─────────┘</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:event-driven-architecture" class="tsd-anchor"></a><h3><a href="#md:event-driven-architecture">Event-Driven Architecture</a></h3><ul>
|
|
<li><strong>EventBus</strong>: Real-time communication between agents</li>
|
|
<li><strong>Task Queue</strong>: Priority-based task scheduling</li>
|
|
<li><strong>Memory Store</strong>: Shared context and learning</li>
|
|
<li><strong>Persistence</strong>: SQLite for state, metrics, and audit trails</li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:📖-documentation" class="tsd-anchor"></a><h2><a href="#md:📖-documentation">📖 Documentation</a></h2><a id="md:getting-started" class="tsd-anchor"></a><h3><a href="#md:getting-started">Getting Started</a></h3><ul>
|
|
<li><a href="docs/AQE-CLI.md">Quick Start Guide</a></li>
|
|
<li><a href="docs/Agentic-QE-Fleet-Specification.md">Agent Types Overview</a></li>
|
|
<li><a href="docs/CONFIGURATION.md">Configuration Guide</a></li>
|
|
</ul>
|
|
<a id="md:user-guides" class="tsd-anchor"></a><h3><a href="#md:user-guides">User Guides</a></h3><ul>
|
|
<li><a href="docs/guides/TEST-GENERATION.md">Test Generation</a></li>
|
|
<li><a href="docs/guides/COVERAGE-ANALYSIS.md">Coverage Analysis</a></li>
|
|
<li><a href="docs/guides/QUALITY-GATES.md">Quality Gates</a></li>
|
|
<li><a href="docs/guides/PERFORMANCE-TESTING.md">Performance Testing</a></li>
|
|
</ul>
|
|
<a id="md:advanced-topics" class="tsd-anchor"></a><h3><a href="#md:advanced-topics">Advanced Topics</a></h3><ul>
|
|
<li><a href="docs/API.md">API Reference</a></li>
|
|
<li><a href="docs/AGENT-DEVELOPMENT.md">Agent Development</a></li>
|
|
<li><a href="docs/CLAUDE-MD-INTEGRATION.md">MCP Integration</a></li>
|
|
<li><a href="docs/AI%20%26%20Agentic%20Security%20Best%20Practices.md">Best Practices</a></li>
|
|
</ul>
|
|
<a id="md:commands-reference" class="tsd-anchor"></a><h3><a href="#md:commands-reference">Commands Reference</a></h3><ul>
|
|
<li><a href="docs/QE-COMMANDS-INDEX.md">AQE Commands Overview</a></li>
|
|
<li><a href="docs/QE-SLASH-COMMANDS-SPECIFICATION.md">Command Specifications</a></li>
|
|
<li><a href="docs/QE_HOOKS_ARCHITECTURE.md">Hooks Architecture</a></li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:🔧-configuration" class="tsd-anchor"></a><h2><a href="#md:🔧-configuration">🔧 Configuration</a></h2><a id="md:environment-variables" class="tsd-anchor"></a><h3><a href="#md:environment-variables">Environment Variables</a></h3><p>Create a <code>.env</code> file in your project root:</p>
|
|
<pre><code class="language-bash"><span class="hl-5"># Fleet Configuration</span><br/><span class="hl-4">FLEET_ID</span><span class="hl-1">=</span><span class="hl-2">my-project-fleet</span><br/><span class="hl-4">MAX_AGENTS</span><span class="hl-1">=</span><span class="hl-8">20</span><br/><span class="hl-4">HEARTBEAT_INTERVAL</span><span class="hl-1">=</span><span class="hl-8">30000</span><br/><br/><span class="hl-5"># Database</span><br/><span class="hl-4">DB_TYPE</span><span class="hl-1">=</span><span class="hl-2">sqlite</span><br/><span class="hl-4">DB_FILENAME</span><span class="hl-1">=</span><span class="hl-2">./data/fleet.db</span><br/><br/><span class="hl-5"># Logging</span><br/><span class="hl-4">LOG_LEVEL</span><span class="hl-1">=</span><span class="hl-2">info</span><br/><span class="hl-4">LOG_FORMAT</span><span class="hl-1">=</span><span class="hl-2">json</span><br/><br/><span class="hl-5"># API (optional)</span><br/><span class="hl-4">API_PORT</span><span class="hl-1">=</span><span class="hl-8">3000</span><br/><span class="hl-4">API_HOST</span><span class="hl-1">=</span><span class="hl-2">localhost</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:fleet-configuration" class="tsd-anchor"></a><h3><a href="#md:fleet-configuration">Fleet Configuration</a></h3><p>Create <code>config/fleet.yaml</code>:</p>
|
|
<pre><code class="language-yaml"><span class="hl-9">fleet</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">id</span><span class="hl-1">: </span><span class="hl-2">"my-project-fleet"</span><br/><span class="hl-1"> </span><span class="hl-9">name</span><span class="hl-1">: </span><span class="hl-2">"My Project QE Fleet"</span><br/><span class="hl-1"> </span><span class="hl-9">maxAgents</span><span class="hl-1">: </span><span class="hl-8">20</span><br/><span class="hl-1"> </span><span class="hl-9">topology</span><span class="hl-1">: </span><span class="hl-10">mesh</span><br/><br/><span class="hl-9">agents</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">test-executor</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">count</span><span class="hl-1">: </span><span class="hl-8">3</span><br/><span class="hl-1"> </span><span class="hl-9">config</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">frameworks</span><span class="hl-1">: [</span><span class="hl-10">jest</span><span class="hl-1">, </span><span class="hl-10">cypress</span><span class="hl-1">, </span><span class="hl-10">playwright</span><span class="hl-1">]</span><br/><span class="hl-1"> </span><span class="hl-9">maxParallelTests</span><span class="hl-1">: </span><span class="hl-8">8</span><br/><span class="hl-1"> </span><span class="hl-9">timeout</span><span class="hl-1">: </span><span class="hl-8">300000</span><br/><br/><span class="hl-1"> </span><span class="hl-9">coverage-analyzer</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">count</span><span class="hl-1">: </span><span class="hl-8">2</span><br/><span class="hl-1"> </span><span class="hl-9">config</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">targetCoverage</span><span class="hl-1">: </span><span class="hl-8">95</span><br/><span class="hl-1"> </span><span class="hl-9">optimizationAlgorithm</span><span class="hl-1">: </span><span class="hl-10">sublinear</span><br/><br/><span class="hl-1"> </span><span class="hl-9">quality-analyzer</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">count</span><span class="hl-1">: </span><span class="hl-8">2</span><br/><span class="hl-1"> </span><span class="hl-9">config</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">tools</span><span class="hl-1">: [</span><span class="hl-10">eslint</span><span class="hl-1">, </span><span class="hl-10">sonarqube</span><span class="hl-1">, </span><span class="hl-10">lighthouse</span><span class="hl-1">]</span><br/><span class="hl-1"> </span><span class="hl-9">thresholds</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">coverage</span><span class="hl-1">: </span><span class="hl-8">80</span><br/><span class="hl-1"> </span><span class="hl-9">complexity</span><span class="hl-1">: </span><span class="hl-8">10</span><br/><span class="hl-1"> </span><span class="hl-9">maintainability</span><span class="hl-1">: </span><span class="hl-8">65</span>
|
|
</code><button>Copy</button></pre>
|
|
<hr>
|
|
<a id="md:🧪-examples" class="tsd-anchor"></a><h2><a href="#md:🧪-examples">🧪 Examples</a></h2><a id="md:test-generation" class="tsd-anchor"></a><h3><a href="#md:test-generation">Test Generation</a></h3><pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Task</span><span class="hl-1">, </span><span class="hl-4">TaskPriority</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'agentic-qe'</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// Generate comprehensive test suite</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">generateTests</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Task</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">'test-generation'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">'Generate Tests for User Service'</span><span class="hl-1">,</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">sourceFile:</span><span class="hl-1"> </span><span class="hl-2">'./src/services/user-service.ts'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">framework:</span><span class="hl-1"> </span><span class="hl-2">'jest'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">coverage:</span><span class="hl-1"> </span><span class="hl-8">95</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">testTypes:</span><span class="hl-1"> [</span><span class="hl-2">'unit'</span><span class="hl-1">, </span><span class="hl-2">'integration'</span><span class="hl-1">, </span><span class="hl-2">'property-based'</span><span class="hl-1">]</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {},</span><br/><span class="hl-1"> </span><span class="hl-4">TaskPriority</span><span class="hl-1">.</span><span class="hl-7">HIGH</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">fleet</span><span class="hl-1">.</span><span class="hl-0">submitTask</span><span class="hl-1">(</span><span class="hl-4">generateTests</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:quality-analysis" class="tsd-anchor"></a><h3><a href="#md:quality-analysis">Quality Analysis</a></h3><pre><code class="language-typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">qualityAnalysis</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Task</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">'quality-analysis'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">'Comprehensive Quality Check'</span><span class="hl-1">,</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">sourcePath:</span><span class="hl-1"> </span><span class="hl-2">'./src'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">tools:</span><span class="hl-1"> [</span><span class="hl-2">'eslint'</span><span class="hl-1">, </span><span class="hl-2">'sonarqube'</span><span class="hl-1">, </span><span class="hl-2">'lighthouse'</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-4">thresholds:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">coverage:</span><span class="hl-1"> </span><span class="hl-8">80</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">complexity:</span><span class="hl-1"> </span><span class="hl-8">10</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">security:</span><span class="hl-1"> </span><span class="hl-8">90</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {},</span><br/><span class="hl-1"> </span><span class="hl-4">TaskPriority</span><span class="hl-1">.</span><span class="hl-7">MEDIUM</span><br/><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:security-scanning" class="tsd-anchor"></a><h3><a href="#md:security-scanning">Security Scanning</a></h3><pre><code class="language-typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">securityScan</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Task</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">'security-scan'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">'SAST & DAST Security Analysis'</span><span class="hl-1">,</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">sourcePath:</span><span class="hl-1"> </span><span class="hl-2">'./src'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">scanTypes:</span><span class="hl-1"> [</span><span class="hl-2">'sast'</span><span class="hl-1">, </span><span class="hl-2">'dast'</span><span class="hl-1">, </span><span class="hl-2">'dependency'</span><span class="hl-1">, </span><span class="hl-2">'container'</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-4">severity:</span><span class="hl-1"> </span><span class="hl-2">'high'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">compliance:</span><span class="hl-1"> [</span><span class="hl-2">'OWASP-Top-10'</span><span class="hl-1">, </span><span class="hl-2">'CWE-Top-25'</span><span class="hl-1">]</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {},</span><br/><span class="hl-1"> </span><span class="hl-4">TaskPriority</span><span class="hl-1">.</span><span class="hl-7">HIGH</span><br/><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>More examples in <a href="examples/">examples/</a></p>
|
|
<hr>
|
|
<a id="md:🐳-docker-deployment" class="tsd-anchor"></a><h2><a href="#md:🐳-docker-deployment">🐳 Docker Deployment</a></h2><a id="md:quick-start" class="tsd-anchor"></a><h3><a href="#md:quick-start">Quick Start</a></h3><pre><code class="language-bash"><span class="hl-5"># Start with SQLite (development)</span><br/><span class="hl-0">docker-compose</span><span class="hl-1"> </span><span class="hl-2">up</span><span class="hl-1"> </span><span class="hl-6">-d</span><br/><br/><span class="hl-5"># Start with PostgreSQL (production)</span><br/><span class="hl-0">docker-compose</span><span class="hl-1"> </span><span class="hl-6">--profile</span><span class="hl-1"> </span><span class="hl-2">postgres</span><span class="hl-1"> </span><span class="hl-2">up</span><span class="hl-1"> </span><span class="hl-6">-d</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:production-deployment" class="tsd-anchor"></a><h3><a href="#md:production-deployment">Production Deployment</a></h3><pre><code class="language-bash"><span class="hl-5"># Configure production environment</span><br/><span class="hl-0">cp</span><span class="hl-1"> </span><span class="hl-2">.env.example</span><span class="hl-1"> </span><span class="hl-2">.env.production</span><br/><span class="hl-5"># Edit .env.production with secure credentials</span><br/><br/><span class="hl-5"># Deploy</span><br/><span class="hl-0">docker-compose</span><span class="hl-1"> </span><span class="hl-6">-f</span><span class="hl-1"> </span><span class="hl-2">docker-compose.yml</span><span class="hl-1"> </span><span class="hl-6">-f</span><span class="hl-1"> </span><span class="hl-2">docker-compose.prod.yml</span><span class="hl-1"> </span><span class="hl-2">up</span><span class="hl-1"> </span><span class="hl-6">-d</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:docker-compose-configuration" class="tsd-anchor"></a><h3><a href="#md:docker-compose-configuration">Docker Compose Configuration</a></h3><pre><code class="language-yaml"><span class="hl-9">version</span><span class="hl-1">: </span><span class="hl-10">'3.8'</span><br/><span class="hl-9">services</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">agentic-qe</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-9">image</span><span class="hl-1">: </span><span class="hl-10">agentic-qe:latest</span><br/><span class="hl-1"> </span><span class="hl-9">environment</span><span class="hl-1">:</span><br/><span class="hl-1"> - </span><span class="hl-10">FLEET_ID=prod-fleet</span><br/><span class="hl-1"> - </span><span class="hl-10">MAX_AGENTS=50</span><br/><span class="hl-1"> - </span><span class="hl-10">DB_TYPE=postgres</span><br/><span class="hl-1"> </span><span class="hl-9">volumes</span><span class="hl-1">:</span><br/><span class="hl-1"> - </span><span class="hl-10">./config:/app/config</span><br/><span class="hl-1"> - </span><span class="hl-10">./data:/app/data</span><br/><span class="hl-1"> </span><span class="hl-9">ports</span><span class="hl-1">:</span><br/><span class="hl-1"> - </span><span class="hl-2">"3000:3000"</span>
|
|
</code><button>Copy</button></pre>
|
|
<hr>
|
|
<a id="md:🚀-development" class="tsd-anchor"></a><h2><a href="#md:🚀-development">🚀 Development</a></h2><a id="md:setup" class="tsd-anchor"></a><h3><a href="#md:setup">Setup</a></h3><pre><code class="language-bash"><span class="hl-5"># Clone repository</span><br/><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-2">clone</span><span class="hl-1"> </span><span class="hl-2">https://github.com/proffesor-for-testing/agentic-qe.git</span><br/><span class="hl-0">cd</span><span class="hl-1"> </span><span class="hl-2">agentic-qe</span><br/><br/><span class="hl-5"># Install dependencies</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><br/><br/><span class="hl-5"># Build</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">build</span><br/><br/><span class="hl-5"># Run tests</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">test</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:available-scripts" class="tsd-anchor"></a><h3><a href="#md:available-scripts">Available Scripts</a></h3><table>
|
|
<thead>
|
|
<tr>
|
|
<th>Script</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><code>npm run build</code></td>
|
|
<td>Compile TypeScript to JavaScript</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm run dev</code></td>
|
|
<td>Development mode with hot reload</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm test</code></td>
|
|
<td>Run all test suites</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm run test:unit</code></td>
|
|
<td>Unit tests only</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm run test:integration</code></td>
|
|
<td>Integration tests</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm run test:coverage</code></td>
|
|
<td>Generate coverage report</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm run lint</code></td>
|
|
<td>ESLint code checking</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm run lint:fix</code></td>
|
|
<td>Auto-fix linting issues</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>npm run typecheck</code></td>
|
|
<td>TypeScript type checking</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<a id="md:project-structure" class="tsd-anchor"></a><h3><a href="#md:project-structure">Project Structure</a></h3><pre><code><span class="hl-4">agentic</span><span class="hl-1">-</span><span class="hl-4">qe</span><span class="hl-1">/</span><br/><span class="hl-1">├── </span><span class="hl-4">src</span><span class="hl-1">/</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">agents</span><span class="hl-1">/ # </span><span class="hl-8">16</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1"> </span><span class="hl-4">implementations</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">core</span><span class="hl-1">/ # </span><span class="hl-4">Core</span><span class="hl-1"> </span><span class="hl-4">fleet</span><span class="hl-1"> </span><span class="hl-4">management</span><br/><span class="hl-1">│ │ ├── </span><span class="hl-4">FleetManager</span><span class="hl-1">.</span><span class="hl-4">ts</span><br/><span class="hl-1">│ │ ├── </span><span class="hl-4">Agent</span><span class="hl-1">.</span><span class="hl-4">ts</span><br/><span class="hl-1">│ │ ├── </span><span class="hl-4">Task</span><span class="hl-1">.</span><span class="hl-4">ts</span><br/><span class="hl-1">│ │ ├── </span><span class="hl-4">EventBus</span><span class="hl-1">.</span><span class="hl-4">ts</span><br/><span class="hl-1">│ │ └── </span><span class="hl-4">MemoryManager</span><span class="hl-1">.</span><span class="hl-4">ts</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">cli</span><span class="hl-1">/ # </span><span class="hl-4">Command</span><span class="hl-1">-</span><span class="hl-4">line</span><span class="hl-1"> </span><span class="hl-6">interface</span><br/><span class="hl-1">│ ├── </span><span class="hl-11">mcp</span><span class="hl-1">/ # </span><span class="hl-11">Model</span><span class="hl-1"> </span><span class="hl-11">Context</span><span class="hl-1"> </span><span class="hl-11">Protocol</span><span class="hl-1"> </span><span class="hl-11">server</span><br/><span class="hl-1">│ ├── </span><span class="hl-11">types</span><span class="hl-1">/ # </span><span class="hl-11">TypeScript</span><span class="hl-1"> </span><span class="hl-11">type</span><span class="hl-1"> </span><span class="hl-11">definitions</span><br/><span class="hl-1">│ └── </span><span class="hl-11">utils</span><span class="hl-1">/ # </span><span class="hl-11">Shared</span><span class="hl-1"> </span><span class="hl-11">utilities</span><br/><span class="hl-1">├── </span><span class="hl-11">tests</span><span class="hl-1">/ # </span><span class="hl-11">Comprehensive</span><span class="hl-1"> </span><span class="hl-11">test</span><span class="hl-1"> </span><span class="hl-11">suites</span><br/><span class="hl-1">│ ├── </span><span class="hl-11">unit</span><span class="hl-1">/</span><br/><span class="hl-1">│ ├── </span><span class="hl-11">integration</span><span class="hl-1">/</span><br/><span class="hl-1">│ ├── </span><span class="hl-11">e2e</span><span class="hl-1">/</span><br/><span class="hl-1">│ └── </span><span class="hl-11">performance</span><span class="hl-1">/</span><br/><span class="hl-1">├── </span><span class="hl-11">examples</span><span class="hl-1">/ # </span><span class="hl-11">Usage</span><span class="hl-1"> </span><span class="hl-11">examples</span><br/><span class="hl-1">├── </span><span class="hl-11">docs</span><span class="hl-1">/ # </span><span class="hl-11">Documentation</span><br/><span class="hl-1">├── .</span><span class="hl-11">claude</span><span class="hl-1">/ # </span><span class="hl-11">Agent</span><span class="hl-1"> & </span><span class="hl-11">command</span><span class="hl-1"> </span><span class="hl-11">definitions</span><br/><span class="hl-1">│ ├── </span><span class="hl-11">agents</span><span class="hl-1">/ # 16 </span><span class="hl-11">QE</span><span class="hl-1"> </span><span class="hl-11">agent</span><span class="hl-1"> </span><span class="hl-11">definitions</span><br/><span class="hl-1">│ └── </span><span class="hl-11">commands</span><span class="hl-1">/ # 8 </span><span class="hl-11">AQE</span><span class="hl-1"> </span><span class="hl-11">slash</span><span class="hl-1"> </span><span class="hl-11">commands</span><br/><span class="hl-1">└── </span><span class="hl-11">config</span><span class="hl-1">/ # </span><span class="hl-11">Configuration</span><span class="hl-1"> </span><span class="hl-11">files</span>
|
|
</code><button>Copy</button></pre>
|
|
<hr>
|
|
<a id="md:📊-performance" class="tsd-anchor"></a><h2><a href="#md:📊-performance">📊 Performance</a></h2><ul>
|
|
<li><strong>Test Generation</strong>: 1000+ tests/minute</li>
|
|
<li><strong>Parallel Execution</strong>: 10,000+ concurrent tests</li>
|
|
<li><strong>Coverage Analysis</strong>: O(log n) complexity</li>
|
|
<li><strong>Data Generation</strong>: 10,000+ records/second</li>
|
|
<li><strong>Agent Spawning</strong>: <100ms per agent</li>
|
|
<li><strong>Memory Efficient</strong>: <2GB for typical projects</li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:🤝-contributing" class="tsd-anchor"></a><h2><a href="#md:🤝-contributing">🤝 Contributing</a></h2><p>We welcome contributions! Please see <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> for details.</p>
|
|
<a id="md:quick-contribution-guide" class="tsd-anchor"></a><h3><a href="#md:quick-contribution-guide">Quick Contribution Guide</a></h3><ol>
|
|
<li>Fork the repository</li>
|
|
<li>Create a feature branch (<code>git checkout -b feature/amazing-feature</code>)</li>
|
|
<li>Make your changes</li>
|
|
<li>Add tests for new functionality</li>
|
|
<li>Ensure all tests pass (<code>npm test</code>)</li>
|
|
<li>Commit your changes (<code>git commit -m 'feat: add amazing feature'</code>)</li>
|
|
<li>Push to your branch (<code>git push origin feature/amazing-feature</code>)</li>
|
|
<li>Open a Pull Request</li>
|
|
</ol>
|
|
<a id="md:development-guidelines" class="tsd-anchor"></a><h3><a href="#md:development-guidelines">Development Guidelines</a></h3><ul>
|
|
<li>Follow the existing code style</li>
|
|
<li>Write comprehensive tests</li>
|
|
<li>Update documentation</li>
|
|
<li>Use conventional commits</li>
|
|
<li>Ensure TypeScript types are accurate</li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:📝-license" class="tsd-anchor"></a><h2><a href="#md:📝-license">📝 License</a></h2><p>This project is licensed under the MIT License - see the <a href="LICENSE">LICENSE</a> file for details.</p>
|
|
<hr>
|
|
<a id="md:🙏-acknowledgments" class="tsd-anchor"></a><h2><a href="#md:🙏-acknowledgments">🙏 Acknowledgments</a></h2><ul>
|
|
<li>Built with TypeScript, Node.js, and SQLite</li>
|
|
<li>Inspired by autonomous agent architectures and swarm intelligence</li>
|
|
<li>Integrates with Jest, Cypress, Playwright, k6, SonarQube, and more</li>
|
|
<li>Compatible with Claude Code via Model Context Protocol (MCP)</li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:📞-support" class="tsd-anchor"></a><h2><a href="#md:📞-support">📞 Support</a></h2><ul>
|
|
<li><strong>Documentation</strong>: <a href="docs/">docs/</a></li>
|
|
<li><strong>Issues</strong>: <a href="https://github.com/proffesor-for-testing/agentic-qe/issues">GitHub Issues</a></li>
|
|
<li><strong>Discussions</strong>: <a href="https://github.com/proffesor-for-testing/agentic-qe/discussions">GitHub Discussions</a></li>
|
|
<li><strong>Email</strong>: <a href="mailto:support@agentic-qe.com">support@agentic-qe.com</a></li>
|
|
</ul>
|
|
<hr>
|
|
<a id="md:🗺️-roadmap" class="tsd-anchor"></a><h2><a href="#md:🗺️-roadmap">🗺️ Roadmap</a></h2><a id="md:current-v10" class="tsd-anchor"></a><h3><a href="#md:current-v10">Current (v1.0)</a></h3><ul>
|
|
<li>✅ 16 specialized QE agents</li>
|
|
<li>✅ Multi-framework test execution</li>
|
|
<li>✅ Real-time coverage analysis</li>
|
|
<li>✅ MCP integration</li>
|
|
</ul>
|
|
<a id="md:planned-v11" class="tsd-anchor"></a><h3><a href="#md:planned-v11">Planned (v1.1)</a></h3><ul>
|
|
<li>🔄 Cloud deployment support</li>
|
|
<li>🔄 GraphQL API</li>
|
|
<li>🔄 Web dashboard</li>
|
|
<li>🔄 CI/CD integrations (GitHub Actions, GitLab CI)</li>
|
|
</ul>
|
|
<a id="md:future-v20" class="tsd-anchor"></a><h3><a href="#md:future-v20">Future (v2.0)</a></h3><ul>
|
|
<li>📋 Machine learning for test prioritization</li>
|
|
<li>📋 Natural language test generation</li>
|
|
<li>📋 Self-healing test suites</li>
|
|
<li>📋 Multi-language support (Python, Java, Go)</li>
|
|
</ul>
|
|
<hr>
|
|
<div align="center">
|
|
|
|
<p><strong>Made with ❤️ by the Agentic QE Team</strong></p>
|
|
<p><a href="https://github.com/proffesor-for-testing/agentic-qe">⭐ Star us on GitHub</a> • <a href="https://twitter.com/agenticqe">🐦 Follow on Twitter</a></p>
|
|
</div></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:agentic-quality-engineering-fleet"><span>Agentic <wbr/>Quality <wbr/>Engineering <wbr/>Fleet</span></a><ul><li><a href="#md:🚀-features"><span>🚀 <wbr/>Features</span></a></li><li><ul><li><a href="#md:autonomous-agent-fleet"><span>Autonomous <wbr/>Agent <wbr/>Fleet</span></a></li><li><a href="#md:comprehensive-testing"><span>Comprehensive <wbr/>Testing</span></a></li><li><a href="#md:quality-intelligence"><span>Quality <wbr/>Intelligence</span></a></li><li><a href="#md:advanced-capabilities"><span>Advanced <wbr/>Capabilities</span></a></li></ul></li><li><a href="#md:📦-prerequisites-amp-installation"><span>📦 <wbr/>Prerequisites & <wbr/>Installation</span></a></li><li><ul><li><a href="#md:prerequisites"><span>Prerequisites</span></a></li><li><ul><li><a href="#md:required"><span>Required</span></a></li><li><a href="#md:optional-advanced-features"><span>Optional (<wbr/>Advanced <wbr/>Features)</span></a></li></ul></li><li><a href="#md:installation-steps"><span>Installation <wbr/>Steps</span></a></li><li><a href="#md:system-requirements"><span>System <wbr/>Requirements</span></a></li></ul></li><li><a href="#md:⚡-quick-start"><span>⚡ <wbr/>Quick <wbr/>Start</span></a></li><li><ul><li><a href="#md:initialize-your-project"><span>Initialize <wbr/>Your <wbr/>Project</span></a></li><li><a href="#md:basic-commands"><span>Basic <wbr/>Commands</span></a></li><li><a href="#md:programmatic-usage"><span>Programmatic <wbr/>Usage</span></a></li></ul></li><li><a href="#md:🤖-agent-types"><span>🤖 <wbr/>Agent <wbr/>Types</span></a></li><li><ul><li><a href="#md:core-testing-agents"><span>Core <wbr/>Testing <wbr/>Agents</span></a></li><li><a href="#md:performance-amp-security"><span>Performance & <wbr/>Security</span></a></li><li><a href="#md:strategic-planning"><span>Strategic <wbr/>Planning</span></a></li><li><a href="#md:advanced-testing"><span>Advanced <wbr/>Testing</span></a></li><li><a href="#md:specialized"><span>Specialized</span></a></li></ul></li><li><a href="#md:🏗️-architecture"><span>🏗️ <wbr/>Architecture</span></a></li><li><ul><li><a href="#md:core-components"><span>Core <wbr/>Components</span></a></li><li><a href="#md:event-driven-architecture"><span>Event-<wbr/>Driven <wbr/>Architecture</span></a></li></ul></li><li><a href="#md:📖-documentation"><span>📖 <wbr/>Documentation</span></a></li><li><ul><li><a href="#md:getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#md:user-guides"><span>User <wbr/>Guides</span></a></li><li><a href="#md:advanced-topics"><span>Advanced <wbr/>Topics</span></a></li><li><a href="#md:commands-reference"><span>Commands <wbr/>Reference</span></a></li></ul></li><li><a href="#md:🔧-configuration"><span>🔧 <wbr/>Configuration</span></a></li><li><ul><li><a href="#md:environment-variables"><span>Environment <wbr/>Variables</span></a></li><li><a href="#md:fleet-configuration"><span>Fleet <wbr/>Configuration</span></a></li></ul></li><li><a href="#md:🧪-examples"><span>🧪 <wbr/>Examples</span></a></li><li><ul><li><a href="#md:test-generation"><span>Test <wbr/>Generation</span></a></li><li><a href="#md:quality-analysis"><span>Quality <wbr/>Analysis</span></a></li><li><a href="#md:security-scanning"><span>Security <wbr/>Scanning</span></a></li></ul></li><li><a href="#md:🐳-docker-deployment"><span>🐳 <wbr/>Docker <wbr/>Deployment</span></a></li><li><ul><li><a href="#md:quick-start"><span>Quick <wbr/>Start</span></a></li><li><a href="#md:production-deployment"><span>Production <wbr/>Deployment</span></a></li><li><a href="#md:docker-compose-configuration"><span>Docker <wbr/>Compose <wbr/>Configuration</span></a></li></ul></li><li><a href="#md:🚀-development"><span>🚀 <wbr/>Development</span></a></li><li><ul><li><a href="#md:setup"><span>Setup</span></a></li><li><a href="#md:available-scripts"><span>Available <wbr/>Scripts</span></a></li><li><a href="#md:project-structure"><span>Project <wbr/>Structure</span></a></li></ul></li><li><a href="#md:📊-performance"><span>📊 <wbr/>Performance</span></a></li><li><a href="#md:🤝-contributing"><span>🤝 <wbr/>Contributing</span></a></li><li><ul><li><a href="#md:quick-contribution-guide"><span>Quick <wbr/>Contribution <wbr/>Guide</span></a></li><li><a href="#md:development-guidelines"><span>Development <wbr/>Guidelines</span></a></li></ul></li><li><a href="#md:📝-license"><span>📝 <wbr/>License</span></a></li><li><a href="#md:🙏-acknowledgments"><span>🙏 <wbr/>Acknowledgments</span></a></li><li><a href="#md:📞-support"><span>📞 <wbr/>Support</span></a></li><li><a href="#md:🗺️-roadmap"><span>🗺️ <wbr/>Roadmap</span></a></li><li><ul><li><a href="#md:current-v10"><span>Current (v1.0)</span></a></li><li><a href="#md:planned-v11"><span>Planned (v1.1)</span></a></li><li><a href="#md:future-v20"><span>Future (v2.0)</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Agentic QE Fleet API Documentation - v1.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |