semvec/pypi-packages huggingface dataset:
githush 0.1.2
A CLI tool to scan repositories for secrets
License: MIT
Requires Python: >=3.12

# 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](https://pypa.github.io/pipx/), which safely installs CLI tools in isolated environments:

```sh
pipx install githush
```

Alternatively, install directly via pip:


```sh
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.
```