How allure-framework/allure3 works
Allure 3 is a TypeScript test-reporting framework centered on a CLI workflow: run tests or collect existing result files, interpret supported formats, aggregate test data, generate reports through configured plugins, and view or monitor the output. The repository also provides agent-oriented artifacts, real-time watching, CI context, and optional TestOps and hosted-service integrations. Paths and relationships for sampled modules are grounded in the tree and excerpts; broader command and plugin wiring follows the README, while unsampled internal links are omitted where uncertain.
Main entry points: plugin.ts Plugin runtime · report.ts Report generation · run.ts Run and generate · index.ts Allure CLI
Components 28
CLI workflows
- Allure CLI
packages/cli/src/index.ts - Run and generate
packages/cli/src/commands/run.ts - Agent workflows
packages/cli/src/commands/agent.ts - Watch command
packages/cli/src/commands/watch.ts
Results ingestion
- Results discovery
packages/cli/src/commands/commons/resultsDiscovery.ts - Format readers
packages/reader/src/index.ts - Reader contract
packages/reader-api/src/reader.ts
Report engine
- Test data model
packages/core-api/src/model.ts - Aggregation
packages/core-api/src/aggregate.ts - Report configuration
packages/core/src/config.ts - Plugin runtime
packages/core/src/plugin.ts - Report generation
packages/core/src/report.ts - Report store
packages/core/src/store/store.ts
Report experience
- Awesome report
packages/plugin-awesome/src/plugin.ts - Classic report
packages/plugin-classic/src/plugin.ts - Allure 2 output
packages/plugin-allure2/src/plugin.ts - Dashboard export
packages/plugin-dashboard/src/plugin.ts - Report interface
packages/web-allure2/src/main/javascript/app/bootstrap.mts - Agent artifacts
packages/plugin-agent/src/plugin.ts
Integrations
- CI context
packages/ci/src/index.ts - TestOps integration
packages/plugin-testops/src/plugin.ts - Hosted service API
packages/service/src/service.ts
Other components
- Engineer
- Test frameworks
- Result files
- Browser user
- Allure TestOps
- Allure service
Connections 31
- Engineer → Allure CLI: runs commands
- Allure CLI → Run and generate: dispatches
- Allure CLI → Agent workflows: dispatches
- Allure CLI → Watch command: dispatches
- Run and generate → Test frameworks: runs tests
- Test frameworks → Result files: write results
- Run and generate → Results discovery: discovers results
- Results discovery → Result files: reads files
- Results discovery → Format readers: supplies inputs
- Format readers → Reader contract: implements contract
- Format readers → Test data model: produces model
- Test data model → Aggregation: feeds aggregation
- Run and generate → Report configuration: loads settings
- Run and generate → Report generation: starts generation
- Report generation → Plugin runtime: dispatches plugins
- Report generation → Aggregation: aggregates results
- Report generation → Report store: writes report data
- Plugin runtime → Awesome report: runs configured
- Plugin runtime → Classic report: runs configured
- Plugin runtime → Allure 2 output: runs configured
- Plugin runtime → Dashboard export: runs configured
- Plugin runtime → Agent artifacts: runs agent output
- Awesome report → Report interface: generates interface
- Browser user → Report interface: views report
- Agent workflows → Agent artifacts: generates artifacts
- Watch command → Result files: monitors changes
- Watch command → Report generation: refreshes report
- Report generation → CI context: uses CI context
- Plugin runtime → TestOps integration: optional integration
- TestOps integration → Allure TestOps: uploads results
- Hosted service API → Allure service: uploads report files