WHAT IS THE JANITOR?
TECHNICAL DEBT REDUCTION
Automatically scans your repo for outdated comments, dead code references, and mismatched function signatures—flagging them before they become bugs.
DOCUMENTATION SYNCING
Detects when your code changes outpace your docs. Generates diff-aware documentation patches and keeps your README and API docs in sync with your actual implementation.
STRUCTURAL ANALYSIS
Maps your repository's architecture and identifies files that violate naming conventions, dependency cycles, or layout standards defined in your config.
USAGE MANUAL
INSTALL
Head to the GitHub Marketplace and click "Install" on the Codebase Janitor app. Select the organization or personal account you want to activate it on, then choose which repositories to include.
GRANT PERMISSIONS
During installation, GitHub will prompt you to authorize two scopes: Read access to repository contents and metadata, and Write access to Pull Requests. No admin rights, secrets, or CI credentials are ever required.
REVIEW PULL REQUESTS
Once installed, the bot monitors your repository for documentation drift and code issues. It automatically opens Pull Requests with suggested fixes for your team to review and merge—no manual trigger needed.
UNDER MAINTENANCE
We are currently refining the direct README-edit feature. Currently, the bot generates suggested content for manual approval. Automatic commits are coming soon.