Skip to content

Latest commit

 

History

History

README.md

PermitCheck Documentation

Complete documentation for PermitCheck - a fast, modern license compliance checker.


📖 Getting Started

Guide Description
Installation Setup and installation
Usage Guide CLI, API, and examples
Configuration Configure license policies
Quick Reference Command cheat sheet

🚀 Integration & Advanced

Guide Description
Output Formats JSON, HTML, SARIF, CSV formats
CI/CD Integration GitHub Actions, GitLab, Jenkins

🔧 For Contributors

Guide Description
Architecture System design, workflow, and components
Adding Languages Create language plugins
Contributing Contribution guidelines
Roadmap Future plans and status

🎯 Quick Start

New User (10 min): InstallRun first checkConfigure

CI/CD Setup (20 min): FormatsCI/CD Guide

Plugin Developer (2 hrs): ArchitecturePlugin GuideExamples


💡 Need Help?