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

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.3.0.tar.gz (11.5 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.3.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: repoclean_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 11.5 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.3.0.tar.gz
Algorithm Hash digest
SHA256 8c62946c206dc6019d3d6eed2239b602711d1d7c8905be2f0720d5495831d413
MD5 41b8586dfbc496351cf69bf9b13d7f6c
BLAKE2b-256 9b6569a51aa9582c44488508fadfeb76d8a474488f1ac06f74598e44e028366a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repoclean_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 13.2 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 963ce812a54fcd93b8ca5c8bc783323662cc9a283be1ba039a677bc987c3a792
MD5 d0d74b8db2655df297f2f5d0dc15b35e
BLAKE2b-256 62ca53b23c611628666d462fee6e98b538a285779e76b2db99b3b99316d948f3

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