RootCause Documentation
Welcome to the complete RootCause documentation. Here you will find everything you need to understand, install, configure, and use RootCause in your projects.
Getting Started
Introduction
Basic concepts, installation, and first steps with RootCause.
User Guide
Basic usage, output options, and CLI configuration.
Roadmap
Future plans, improvements, and new features.
Architecture
High-Level Overview
General architecture and data flow of RootCause.
Low-Level Details
Technical implementation and internal components.
Components
- Engine - Analysis engine
- IR - Intermediate representation
- Loader - Rules loader
- RootCause CLI - Command-line interface
- Reporters - Report generators
- Rego WASM - Rego rules support
Parsers
- Dashboard - Parsers status
- JavaScript - JavaScript parser
- TypeScript - TypeScript parser
- Python - Python parser
- Go - Go parser
- Rust - Rust parser
- PHP - PHP parser
- Ruby - Ruby parser
- JSON - JSON parser
- YAML - YAML parser
- HCL - HCL parser
- Dockerfile - Dockerfile parser
- Maturity Levels - Evaluation criteria
Rules
Quick Start
Create your first rule in minutes.
Rule Types
Different ways to define rules.
Advanced Rules
Comprehensive guide to creating professional rules.
Rule Examples
Collection of useful rules organised by language.
Rule Testing
Guide to testing and validating rules.
Overview
General overview of the rule system.
Plugins
Plugin System
Extend RootCause with external plugins for custom analysis.
Plugin Development
Comprehensive guide to creating plugins for RootCause.
API Reference
Complete JSON-RPC protocol for RootCause plugins.
Plugin Examples
Collection of example plugins for different use cases.
Plugin Security
Sandboxing, resource limits, and security best practices.
Plugin Testing
Guide to testing and validating plugins.
Plugin Distribution
Guide to packaging and distributing RootCause plugins.
User Guide
First Steps
Step-by-step guide for new users.
What is RootCause?
Detailed explanation of what RootCause is and what it is for.
CI/CD Integration
How to integrate RootCause into CI/CD pipelines.
Examples
CI/CD Integration
Practical examples of integration with GitHub Actions and other platforms.
This documentation is updated regularly. If you find any errors or have suggestions, please contact us.