repo-scan/README.md

Scan git repos for uncommitted changes and upstream status

# repo-scan

`repo-scan` is a simple CLI tool that scans directories for Git repositories and reports their status:

- Uncommitted changes
- Commits ahead of upstream
- Repositories without an upstream branch
- Clean repositories

## Installation

From NPM:

```bash
npm install -g repo-scan
# or
npx repo-scan
```

Local:

```bash
git clone https://github.com/joshterrill/repo-scan.git
cd repo-scan
npm install -g
```

## Usage

```bash
# default directory is current directory and default depth is 3
repo-scan [directory] [--depth=n]
```

## License

MIT