Reference Documentation
Complete technical reference for TestBeats - your go-to resource for detailed specifications, API documentation, and configuration options.
📚 Quick Navigation
- Guides - Complete step-by-step guides for getting started and solving specific problems
🔍 What's in This Section
This reference section contains:
⚡ CLI Reference
Complete command-line interface documentation:
- publish - Publish test results
- init - Initialize configuration files
- manual sync - Sync manual test cases from CI
⚙️ Configuration
Detailed configuration options:
- Environment Variables - Environment-based configuration
- Run metadata - Metadata on the test run (configuration)
🎯 Targets
Delivery target configurations:
- Slack - Slack integration reference
- Microsoft Teams - Teams integration reference
- Google Chat - Google Chat integration
- InfluxDB - InfluxDB integration
- GitHub - GitHub integration
- GitHub Output - GitHub Actions
GITHUB_OUTPUT - HTTP - HTTP target
- Custom Targets - Building custom targets
- Delay - Delayed delivery
🔌 Extensions
Extension system reference:
- Introduction - Concepts and syntax
- CI Info - CI/CD information extension
- Hyperlinks - Dynamic link generation
- Mentions - User/team mentions
- Metadata extension - Custom metadata injection
- Chart Test Summary - Visual charts
- Percy Analysis - Percy visual testing
- ReportPortal Analysis - ReportPortal integration
- ReportPortal History - Historical ReportPortal data
- Custom Extensions - Building extensions
🎯 How to Use This Section
This reference documentation is organized by topic and provides:
- Complete specifications for all features
- Parameter details with types and examples
- Return values and error codes
- Configuration schemas with validation rules
Finding What You Need
- New to TestBeats? Start with Guides
- Looking for examples? Check Guides for practical implementations
- Need technical details? You're in the right place!
🔗 Cross-References
This reference documentation frequently links to:
- Guides - For practical examples and step-by-step instructions
Looking for step-by-step instructions? Check our Complete Guides →