Home

GitLab CI Lint Wiki

Welcome to the GitLab CI Lint documentation!

Getting Started

• Quick Start - Get started in 5 minutes
• Installation Guide - Detailed installation instructions
• Configuration Guide - Configure gitlab-ci-lint

Documentation

User Guides

• Basic Usage - Practical examples and common workflows
• CI/CD Integration - Integrate with your CI/CD pipelines
• Troubleshooting - Common issues and solutions

Technical Documentation

• Technical Specification - Complete project specification
• Architecture Overview - System design and components
• API Reference - Internal API documentation

Development

• Implementation Status - Feature completion status
• Contributing - Contribution guidelines
• Roadmap - Development roadmap

Quick Links

• GitHub Repository
• Releases
• Issues
• Discussions

About

GitLab CI Lint is a command-line tool that validates .gitlab-ci.yml configuration files in two stages:

1. Local Validation: Fast YAML syntax checking (no API required)
2. API Validation: Full GitLab instance validation via GitLab API (optional)

Key Features

• Fast: Local validation without API calls
• Flexible: Multiple configuration sources (file, env, flags)
• Smart: Auto-discovery of CI files
• Integration-ready: JSON/YAML output for automation
• Interactive: Setup wizard for easy configuration

Example

# Quick validation
gitlab-ci-lint .gitlab-ci.yml

# Skip API validation (offline)
gitlab-ci-lint --skip-api .gitlab-ci.yml

# JSON output for automation
gitlab-ci-lint --output json .gitlab-ci.yml

# Project-specific validation
gitlab-ci-lint --project group/project .gitlab-ci.yml

Installation

# Download binary
curl -sSL https://github.com/InkyQuill/gitlab-ci-lint/releases/latest/download/gitlab-ci-lint-linux-amd64 -o gitlab-ci-lint

# Make executable
chmod +x gitlab-ci-lint

# Run
./gitlab-ci-lint .gitlab-ci.yml

For more installation methods, see the Installation Guide.