First steps

Guide to getting started with RootCause.

Installation

Requirements: You need to have Rust and Cargo installed.

Via script

Installation using the install script

curl https://rootcause.sh/install.sh | sh

Via Git

Installation from the Git repository

1. Clone the repository:

   git clone https://github.com/RootCauseScan/scanner.git
   cd scanner

2. Build the CLI:

   cargo build -p rootcause --release

3. Run the CLI:

   ./target/release/rootcause . --rules rules

Via Cargo install

Installation using Cargo install

cargo install rootcause

Configuration file

RootCause uses a configuration file in TOML format located at:

• Linux/macOS: ~/.config/rootcause/config.toml
• Windows: %APPDATA%\\rootcause\\config.toml

Basic structure of config.toml

# Cache configuration
[cache]
cache_dir = "./cache"

# Rules configuration
[rules]
rule_dirs = ["/home/user/.config/rootcause/rules", "./custom-rules"]

# Plugins configuration
[plugins.plugin-name]
enabled = true
plugin_option = "VALUE"

Verify the installation

Run the help command to verify that RootCause is installed correctly:

rootcause --help

You should see the output with the available commands:

• scan - Scan code
• rules - Manage rules
• plugins - Manage plugins

Next steps

1. Run your first scan: See First scan
2. Install rules: Use rootcause rules install https://rootcausescan/rules to download the official rules bundle.
3. Explore plugins: Discover installed plugins with rootcause plugins list