repolyze
Analyze a git source code repository for health signals and project vitals
## Usage
Analyze the current directory as a git repository and print JSON (for tooling or AI agents):
```bash
npx repolyze --json .
```
Analyze another path:
```bash
npx repolyze --json /path/to/repo
```
Emit a Markdown report optimized for LLM consumption:
```bash
npx repolyze --markdown .
```
Verbose mode (prints `git` invocations to stderr):
```bash
npx repolyze --verbose .
```
Help:
```bash
npx repolyze --help
```
When the package is installed globally, use the `repolyze` command the same way (for example `repolyze --json .`).
## Screenshots
## Requirements
- [Node.js](https://nodejs.org/) v24 or newer
- [`git`](https://git-scm.com/) available on your `PATH`
## Install
Install globally (pick your package manager):
```sh
npm install -g repolyze
```
```sh
pnpm add -g repolyze
```
Or run **without** installing, using `npx` (downloads the package for that invocation):
```sh
npx repolyze --help
```
## Credits & References
The default signals this tool collects mirror the git workflow described by **[Ally Piechowski](http://github.com/grepsedawk)** in *[The Git Commands I Run Before Reading Any Code](https://piechowski.io/post/git-commands-before-reading-code/)*. See [docs/repository-analysis.md](./docs/repository-analysis.md) for command-by-command notes, caveats, and the same attribution in context.
References:
- [fallow-rs](https://github.com/fallow-rs/fallow) - Static analysis for source code health based on git
- [vibe-security-radar](https://github.com/HQ1995/vibe-security-radar) - Georgia Tech SSLab research that correlates public CVE/advisory data with git history (blame, fix commits, squash-merge context) and commit-metadata heuristics (co-authors, bot emails, tool markers), with LLM-assisted triage—not a drop-in for repolyze, but a useful contrast for how far you can push **git- and commit-derived** security storytelling
## Documentation
- [Project documentation](./docs/README.md) - development, testing, architecture, and conventions.
## Contributing
Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.
**Developing this repo locally** (running from source, tests, build): see [docs/development.md](./docs/development.md).
## Author
**repolyze** © [Liran Tal](https://github.com/lirantal), Released under the [Apache-2.0](./LICENSE) License.