https://github.com/aolingge/agentignore-check
Check whether a repo has an .agentignore-style file to keep AI agents away from secrets and noisy files.
https://github.com/aolingge/agentignore-check
agentignore ai-agent cli developer-tools privacy secret-scanning
Last synced: 2 months ago
JSON representation
Check whether a repo has an .agentignore-style file to keep AI agents away from secrets and noisy files.
- Host: GitHub
- URL: https://github.com/aolingge/agentignore-check
- Owner: aolingge
- License: mit
- Created: 2026-04-25T08:30:34.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-04-25T09:55:27.000Z (2 months ago)
- Last Synced: 2026-04-25T10:28:49.534Z (2 months ago)
- Topics: agentignore, ai-agent, cli, developer-tools, privacy, secret-scanning
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Agentignore Check
Check whether a repo has an .agentignore-style file to keep AI agents away from secrets and noisy files.
中文 · Quick Start · Checks
## Why This Exists
AI agent tooling is growing quickly, but many repos still miss tiny checks that can run locally or in CI. This project stays zero-dependency, short-command, and easy to fork.
## Quick Start
```bash
npx github:aolingge/agentignore-check --path .agentignore
```
Generate Markdown:
```bash
npx github:aolingge/agentignore-check --path .agentignore --markdown > report.md
```
Use a score gate:
```bash
npx github:aolingge/agentignore-check --path .agentignore --min-score 80
```
## Checks
| Check | What it looks for |
| --- | --- |
| env | Ignores env and secret files. |
| logs | Ignores logs. |
| build | Ignores generated dependencies and builds. |
| private | Ignores private data. |
## Output
```text
Agentignore Check score: 100/100
PASS example-check Useful signal found
FAIL missing-check Add the missing guidance
```
## Quality Gate
Use this project as a repeatable gate before an AI agent marks work as done:
- [Quality gate guide](docs/quality-gates.md)
- [Copy-ready GitHub Actions example](examples/github-action.yml)
## CI Usage
Use GitHub Actions annotations:
```bash
npx github:aolingge/agentignore-check --path fixtures/good.txt --annotations
```
Generate SARIF:
```bash
npx github:aolingge/agentignore-check --path fixtures/good.txt --sarif > results.sarif
```
See [docs/github-actions.md](docs/github-actions.md).
## Visual Identity
The banner and CLI preview are SVG assets committed in `assets/`, so the README renders cleanly on GitHub and Gitee without external image hosting.
## Mirrors
- GitHub: https://github.com/aolingge/agentignore-check
- Gitee: https://gitee.com/aolingge/agentignore-check
## Contributing
Good first PRs: add checks, add fixtures, improve docs, or add GitHub Actions examples.
## License
MIT