Open the part you need.
Complete repository documentation: installation, workflows, configuration, and reference.
Opal Documentation →
Opal executes GitLab-style CI pipelines locally so you can iterate without pushing to a remote runner. This documentation gives you the high-level tour of how the system is structured and where to look for specific topics.
Install →
cargo install --path crates/opal
Quick Start →
cargo install --path crates/opal
Pipeline Model →
This document describes how Opal interprets `.gitlab-ci.yml` and schedules jobs locally.
Opal Plan →
`opal plan` lets you explore the pipeline graph without spinning up containers. It uses the same parser and rule evaluation as `opal run`, so the output is a faithful preview of what will execute when you launch a real run.
Opal Configuration →
Opal reads a layered `config.toml` to customize runtime behavior and automatically handle container registry authentication. Two locations are checked (later entries override earlier ones):
AI Configuration →
This page documents how to configure Opal's AI-assisted job troubleshooting backends, prompt files, and saved-analysis behavior.
AI Troubleshooting →
This page tracks Opal's AI-assisted job troubleshooting feature.
GitLab Feature Parity →
This page tracks which `.gitlab-ci.yml` features Opal currently recognizes and how that compares with GitLab's official CI/CD YAML surface.
User Interface →
The Ratatui-based UI is optimized for keyboard navigation. This document complements the in-app shortcut list and explains each pane in detail.
CLI Reference →
This page documents the current Opal command-line surface directly from the implementation.
Opal MCP Agent Playbook →
This document is meant to be handed to a coding agent such as Codex.
Storage And Local State →
This page documents where Opal stores local state, how per-job workspaces are prepared, how cache and artifacts are laid out on disk, and how project-level `.opal` content interacts with global configuration.
Technical Debt →
Architecture and maintenance notes for Opal.
Documentation snapshot from https://github.com/cloudflavor/opal at revision 194af1f1fbef, not a current-release selector.