Skip to main content

Repo hygiene scanner and fixer (junk files, secrets, gitignore).

Project description

repoclean

A repo hygiene CLI tool to scan repositories for common junk artifacts, detect secret/token patterns, and optionally install a git pre-commit hook to prevent leaks.

Why repoclean exists

Most developers (especially students) accidentally commit junk and sensitive files at least once:

  • __pycache__/, *.pyc, venv/, node_modules/
  • .env files
  • API keys/tokens and private keys

These mistakes are common, embarrassing, and sometimes expensive.

repoclean is a small CLI tool meant to be run before pushing to GitHub. It helps you quickly:

  • spot repo hygiene issues
  • detect secret/token patterns
  • block accidental leaks via an optional git pre-commit hook

Install

pip install repoclean-cli

Quick Start

repoclean scan repoclean secrets

CI usage

repoclean ci repoclean scan --fail-on sensitive,large repoclean secrets --fail

Typical workflow

repoclean scan repoclean secrets --fail repoclean fix --yes repoclean install-hook

Commands

Scan repo hygiene issues

repoclean scan

Create a default .gitignore

repoclean init

Safely clean junk files/folders

Preview:

repoclean fix --dry-run --verbose

Apply cleanup:

repoclean fix --yes

Scan for secrets/tokens

repoclean secrets

Fail mode (useful for CI and hooks):

repoclean secrets --fail

Install git pre-commit hook

repoclean install-hook

Uninstall:

repoclean uninstall-hook

Notes

  • repoclean is the command name.
  • The PyPI package name is repoclean-cli.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repoclean_cli-0.5.0.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repoclean_cli-0.5.0-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file repoclean_cli-0.5.0.tar.gz.

File metadata

  • Download URL: repoclean_cli-0.5.0.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.6

File hashes

Hashes for repoclean_cli-0.5.0.tar.gz
Algorithm Hash digest
SHA256 7ce8d15d808a5d812aadd31ab559c5621ef323fc9835b5592798779c831a661f
MD5 1fa13cb9ee53315ed136d3c4c2e5a11f
BLAKE2b-256 55c9553b605907402910f5a4ada550bf1a6bcbd0cee6ed6815ec8db0f25394ee

See more details on using hashes here.

File details

Details for the file repoclean_cli-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: repoclean_cli-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.6

File hashes

Hashes for repoclean_cli-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e65055105da9493ce12cb568b151f585d74bffc4dd9f6357a51f0eee4f833689
MD5 250feb6d79772c554f3cc7ee80817a78
BLAKE2b-256 b0620b8e79b224e5e691eccd9d89bee7fe5306d13ec7c5dddc0846fb532fb3e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page