https://github.com/dotanuki-labs/canopus

A fast and pragmatic validator for Github Codeowners
https://github.com/dotanuki-labs/canopus

cli codeowners github rust

Last synced: 3 months ago
JSON representation

A fast and pragmatic validator for Github Codeowners

• Host: GitHub
• URL: https://github.com/dotanuki-labs/canopus
• Owner: dotanuki-labs
• License: mit
• Created: 2025-06-11T04:05:03.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-10-08T04:56:57.000Z (3 months ago)
• Last Synced: 2025-10-08T06:27:37.604Z (3 months ago)
• Topics: cli, codeowners, github, rust
• Language: Rust
• Homepage: https://dotanuki-labs.github.io/canopus/
• Size: 430 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# canopus

[![best practices](https://www.bestpractices.dev/projects/11177/badge)](https://www.bestpractices.dev/projects/11177)

[![DeepSource](https://app.deepsource.com/gh/dotanuki-labs/canopus.svg/?label=active+issues&show_trend=false&token=LQiIpIl6403szs6dIY1dhYkx)](https://app.deepsource.com/gh/dotanuki-labs/canopus/)

[![CI](https://github.com/dotanuki-labs/canopus/actions/workflows/ci.yml/badge.svg)](https://github.com/dotanuki-labs/canopus/actions/workflows/ci.yml)

[![crates.io](https://img.shields.io/crates/v/canopus)](https://crates.io/crates/canopus)

[![ghcr.io](https://img.shields.io/badge/docker-ghcr.io-blue?logo=docker)](https://github.com/dotanuki-labs/canopus/pkgs/container/canopus)

![license](https://img.shields.io/crates/l/canopus)

> A fast and pragmatic validator for Github Codeowners

`canopus` is a small, fast and standalone CLI tool for validating

[Github Codeowners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)

written in pure Rust. It should be fast enough to be configured as a

[Git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)

in offline mode, and eventually also in online mode.

## Main features

- local validation of `CODEOWNERS`, including additional syntax checks

- quick repairing of `CODEOWNERS`

- offline and online execution modes

- sensible opt-ins for better `CODEOWNERS` structure

Please check our [documentation](https://dotanuki-labs.github.io/canopus/)

to learn more!

## License

Copyright © 2025 — Dotanuki Labs - [The MIT license](https://choosealicense.com/licenses/mit)