Karandash Documentation
The fastest, most extensible merge request validation tool.
Features
- Fast: Native binary with ~50ms startup
- Many rules: 21 built-in validation rules
- Extensible: Plugin system for custom logic (Kotlin/JS)
- Simple: Kotlin-like DSL or YAML configuration
- Multi-platform: GitLab, GitHub, Bitbucket, Azure DevOps, Gerrit, Gitea, AWS CodeCommit
Quick Start
# Create config
karandash init
# Validate MR
karandash validate
Documentation Structure
Getting Started
- Installation - Install Karandash on your platform
- Quick Start - Get up and running in 5 minutes
Configuration
- YAML Configuration - YAML-based configuration guide
- Zero Config Mode - Run with sensible defaults
Rules
- Rules Overview - All available validation rules
- Individual rule documentation for approvals, branch naming, CI/CD status, and more
Plugins
- Plugin Overview - Plugin system introduction
- Plugin Tutorial - Step-by-step plugin development
- Native Plugin Guide - Kotlin Multiplatform plugins
- JS Plugin Guide - JavaScript plugins
Platform Guides
- Platform Support - All supported platforms
- GitLab, GitHub, Bitbucket, Azure DevOps, Gerrit, Gitea, AWS CodeCommit
Integrations
- CI/CD Integration - GitHub Actions, GitLab CI, Jenkins, etc.
Guides
- Publishing Plugins - Share your plugins
- Troubleshooting - Common issues and solutions
Features
- Auto-Fix - Automatic issue resolution
- Watch Mode - Real-time validation
- Config Inheritance - Shared configurations
Advanced
- Build from Source - Build Karandash yourself
- Architecture - Multiplatform architecture
- Plugin System - Deep dive into plugin architecture
Reference
- CLI Commands - Complete CLI reference