Skip to main content

A CLI tool to scan repositories for secrets

Project description

Githush

Githush is a CLI tool that scans repositories for exposed secrets and prevents unsafe commits using Git hooks and CI/CD pipelines.


🚀 Features

  • 🔍 Secret scanning for exposed credentials in repositories
  • 🔐 Pre-commit hook integration to block unsafe commits
  • ⚙️ CI/CD compatibility to enforce security in pipelines

📦 Installation

Install via pipx, which safely installs CLI tools in isolated environments:

pipx install githush

Alternatively, install directly via pip:

pip install githush

🧪 Usage

🔍 Scan a repository

Usage: githush scan [OPTIONS] PATH

  Scan a repository or directory for exposed secrets.

Options:
  --staged-only       Scan only staged files.
  --config-path PATH  Path to the githush configuration file.
  --help              Show this message and exit.

🪝 Install the pre-commit git hook

Usage: githush install-hook [OPTIONS] PATH

  Install pre commit hook to block commits containing secrets.

Options:
  --help  Show this message and exit.

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

githush-0.1.2.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

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

githush-0.1.2-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file githush-0.1.2.tar.gz.

File metadata

  • Download URL: githush-0.1.2.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.8

File hashes

Hashes for githush-0.1.2.tar.gz
Algorithm Hash digest
SHA256 fa7fedf75c2fed4ddc5f835830bff7594d016ba916868b8ab01b278458f5ee0d
MD5 5f9c92ab8746b2c4891db83fc0cbcc7f
BLAKE2b-256 0759e7fb927aee6e992a291dc682f159fdf2da766591e1b82eb66238ef7b643e

See more details on using hashes here.

File details

Details for the file githush-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: githush-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.8

File hashes

Hashes for githush-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d076fae8d43b63bcdf6606ebc14ce68959f1bece68887c193fb2b35a1747546f
MD5 cc9a093bd2943efd2f68ee417fcef581
BLAKE2b-256 3cc381c6e9dfff5660fa9b1c2dac28d594d96b70d28412ac8048a1c28516a0bb

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