Skip to main content

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

Project description

PyPI License CI

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

Demo

repoclean scan repoclean secrets --fail repoclean install-hook --mode strict

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.2.tar.gz (13.4 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.2-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: repoclean_cli-0.5.2.tar.gz
  • Upload date:
  • Size: 13.4 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.2.tar.gz
Algorithm Hash digest
SHA256 41960d905e3778094ed9236ff6b754564ceea136ea5258f044b4d71e50416447
MD5 9b3778c67659936d4829dd7c5dccd81d
BLAKE2b-256 9de0569c7e84aa3694b9d16b83a6a0bdecc08c2f6f10660041f193a9373f7390

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repoclean_cli-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 15.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ea7eaee8cb6e97945c19ba942a95d4a3a9eddce2a95cb32984b9a46aacd5032e
MD5 1de7f0159ea5a74c36568e44a2460c3c
BLAKE2b-256 84c6f685dff0503b2bfa078733a9f0754c85e54270c188c0c8b888b0f24b619f

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