Skip to main content

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

Project description

Repoclean (CLI) v0.6.0

PyPI License CI

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

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

Demo

repoclean demo

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 --mode strict

Secrets severity + CI

repoclean secrets --min-severity high
repoclean secrets --fail-on critical
repoclean ci --json

Command

Scan repo hygiene issues
repoclean scan
Create a default .gitignore
repoclean init
Config

Create a .repoclean.toml config file:

repoclean config 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

Install (strict mode blocks commit on issues):
repoclean install-hook --mode strict
Install (warn mode prints warnings but allows commit):
repoclean install-hook --mode warn
Uninstall:
repoclean uninstall-hook
Hook utilities:
repoclean hook status
repoclean hook print --mode warn
repoclean hook print --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.6.0.tar.gz (14.9 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.6.0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: repoclean_cli-0.6.0.tar.gz
  • Upload date:
  • Size: 14.9 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.6.0.tar.gz
Algorithm Hash digest
SHA256 cf39b2e33d4de5df81022bc06bdbca95599c1593b06492a0520e82a8dae54294
MD5 44ed737d45b61c30a75911a3c10ac1c6
BLAKE2b-256 f534cf2ac6602452687e4c0035e2aab0967bc949c04f05470a32da20b0134d48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repoclean_cli-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 16.9 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc9b4cfca1a25c6f4ce295427fb334774751b153a0583af71201bb35520e2645
MD5 2b0b4a89dad32331051abcf790ed6e8b
BLAKE2b-256 9e32bc30ad19610068b4955f9c0a19943918314dd97a5f286c5503ac3a9b1746

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