⚡ docsfy

rootcoz

Understand failing CI runs, collaborate on fixes, and create follow-up issues faster.

Get Started →

Getting Started

  • Quickstart

    Run RootCoz, sign in, and submit your first Jenkins, Prow, or JUnit XML analysis in just a few minutes.

Explore →

User Guides

  • Submitting Analyses

    Analyze Jenkins builds, Prow jobs, or JUnit XML files and choose the input mode that matches the failure data you already have.

  • Configuring Analysis Context

    Improve analysis quality by selecting AI models, enabling peer review, attaching a tests repo, and adding extra repositories for context.

  • Tracking Analysis Progress

    Watch queued and running jobs from the dashboard, follow live status updates, and know when to abort or rerun an analysis.

  • Reviewing and Classifying Failures

    Inspect grouped failures, compare AI reasoning, mark reviews complete, and override classifications or patterns when the default answer needs correction.

  • Collaborating on Results

    Keep review work in one place by adding comments, mentioning teammates, and chatting with AI about a specific job.

  • Managing Your Account and Notifications

    Rotate your API key, save GitHub and Jira tokens, and enable mention notifications so follow-up work works across the UI and CLI.

  • Creating Follow-Up Issues and Pushing Results

    Turn failures into GitHub issues or Jira bugs, link external trackers back to jobs, and push classifications to Report Portal when needed.

  • Exploring History and Reports

    Search recurring failures, drill into test history, and compare team-level trends across dates, labels, metadata, and review status.

  • Managing Users and Server Settings

    Approve users, assign roles, grant reports access, and set server-wide AI, CI, auth, and integration defaults as an administrator.

  • Use Server Chat for Cross-Job Analysis

    Show administrators how to ask RootCoz questions across all jobs, choose or override the AI model, follow live replies in the web UI or CLI, abort or clear a session, and save or download HTML report artifacts from chat output.

Explore →

Recipes

  • Automating Common Tasks with the CLI

    Install the CLI, save server profiles, and script repeated tasks such as listing results, exporting reports, and reanalyzing failures.

  • Deploying RootCoz

    Bring up RootCoz with Docker Compose for local use or Helm for Kubernetes and OpenShift when you need a shared deployment.

Explore →

Reference

  • API Endpoint Reference

    Look up request and response details for analysis, results, history, auth, reports, chat, admin, and notification endpoints.

  • CLI Command Reference

    Find every rootcoz command, flag, and output mode for results, history, comments, metadata, auth, reports, and admin workflows.

  • Configuration Reference

    Check environment variables, server settings, Helm values, and per-repository .rootcoz options when you need to tune behavior or integrations.

Explore →
🤖
AI-friendly documentation

This documentation is optimized for AI consumption.