Skip to content
Purplemet CI edited this page Apr 28, 2026 · 6 revisions

Documentation

Getting Started

Document Description
README Installation, quick start, and command reference
Configuration Environment variables, config file, .env file
Docker Docker image usage and CI/CD examples

Understanding Results

Document Description
Interpreting Results How to read and act on analysis reports
Exit Codes Exit code reference with CI/CD recommendations
FAQ & Troubleshooting Common errors and solutions

Commands

Document Description
Issues Management Ignore, activate, and comment on issues
Technology Detection List and monitor detected technologies

CI/CD Integrations

Platform Guide
GitHub Actions Guide
GitLab CI/CD Guide
Bitbucket Pipelines Guide
Jenkins Guide
Azure DevOps Guide

Reference

Document Description
API Reference Official Purplemet REST API documentation (OpenAPI/Swagger)
Releases Release history and binaries

Clone this wiki locally