https://github.com/mattmahn/git-key-grep
Search your git repo for any mistakenly tracked API keys.
https://github.com/mattmahn/git-key-grep
git git-addons
Last synced: 6 months ago
JSON representation
Search your git repo for any mistakenly tracked API keys.
- Host: GitHub
- URL: https://github.com/mattmahn/git-key-grep
- Owner: mattmahn
- License: unlicense
- Created: 2017-04-21T05:11:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-19T02:39:50.000Z (over 7 years ago)
- Last Synced: 2025-02-10T05:44:12.643Z (8 months ago)
- Topics: git, git-addons
- Language: Roff
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# git-key-grep
Search your Git repo for any mistakenly tracked API keys.
## Usage
Inside a Git repository, simply run `git key-grep` to find any API keys that
are in the repository (i.e. in any file that is tracked or staged to be
tracked). Matched patterns can be ignored by adding `git-key-grep-ignore`
anywhere on the line (a comment would be a good place).
### pre-commit
git-key-grep is compatible with [pre-commit][] with something like the
following in your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/mattmahn/git-key-grep.git
sha: HEAD
hooks:
- id: git-key-grep
```
## Installation
Dependencies:
- C compiler
- Git
- Make (only for installation)
### Unix
```sh
git clone --recurse-submodules https://github.com/mattmahn/git-key-grep.git
cd git-key-grep
make
sudo make install
cd ..
rm -rf git-key-grep
```
## Related Works
If you do find something in a repo you want removed, you can try [BFG
Repo-Cleaner][bfg].
## Contributing
Thanks for your interest in contributing. Checkout
[CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
[bfg]: https://rtyley.github.io/bfg-repo-cleaner/
[pre-commit]: http://pre-commit.com