Skip to content

README.md

Latest commit

 

History

History
56 lines (34 loc) · 1.63 KB

README.md

File metadata and controls

56 lines (34 loc) · 1.63 KB

Code-Guardian Documentation

Welcome to the Code-Guardian documentation! This section contains tutorials, guides, and reference materials.

Tutorials

Getting Started

Learn the basics of scanning your codebase and generating reports.

Advanced Usage

Explore advanced features like custom databases, scan comparisons, and programmatic processing.

Custom Detectors Guide

Learn how to create and use custom pattern detectors for security, code quality, and project-specific rules.

Automation

Set up automated scanning with CI/CD, cron jobs, and monitoring.

Branch Protection Setup

Learn how to set up branch protection rules for your repository.

API Documentation

The full API documentation is available at: GitHub Pages

To generate docs locally:

cargo doc --open

Contributing

See CONTRIBUTING.md for development guidelines.

Examples

Check out the examples directory for sample usage and output formats.

Architecture

Code-Guardian follows a modular architecture:

  • core: Scanning logic and pattern detection
  • storage: SQLite database operations
  • output: Multiple output format support
  • cli: Command-line interface

Support

License

Code-Guardian is licensed under LICENSE.