gitleaks · Gitleaks
Gitleaks for AI Agents
Find hard-coded secrets in repositories and changesets with JSON, SARIF, or CSV evidence.
Install for an Agent
Choose an official installation path that matches the runtime. Pin a version for team or CI use, then record the version before the first task.
Structured Output for Reliable Automation
Prefer a machine-readable format. Treat stdout as the result channel and stderr as diagnostics so the agent can parse failures separately.
R0–R3 Command Risk Guide
Risk is assigned per command. R0 is local or remote read-only, R1 is reversible local write, R2 changes remote state, and R3 can be irreversible or production-impacting.
Read-only does not mean public
R0 only means the command does not change local or remote state. A read-only command may still return secrets, identity data, configuration, or production data. Expose only the minimum needed for the task, and never place it in logs, prompts, or commits.
How the Agent Readiness Score Is Built
Readiness describes how reliably an agent can operate the tool. It does not make every command safe and it does not replace an independent execution test.
Documentation indicates an agent-readiness score of 86/100. No local execution test has been recorded.
Generate a Skill or Agent Policy
Choose an agent and safety mode to generate a copyable artifact with installation, allowed commands, approval boundaries, and the evidence limitation.
---
name: gitleaks-agent-workflow
description: Use Gitleaks for secret scanning, pre-commit checks, Git history with explicit command risk and evidence boundaries.
---
# Gitleaks agent workflow
Use this skill when the task needs secret scanning, pre-commit checks, Git history, SARIF reports.
## Evidence boundary
- Registry confidence: `docs-verified`
- Documentation checked: `2026-07-10`
- Locally tested version: `not tested`
- Do not describe this CLI as locally verified until its commands have actually been executed in an isolated environment.
## Executed smoke checks
- No local execution record is available.
## Installation
- Homebrew (macos, linux): `brew install gitleaks`
- winget (windows): `winget install Gitleaks.Gitleaks`
## Authentication
- Methods: none
- Secret environment variables: none
- Minimum permissions: No service credential is required; restrict filesystem and network access to the task.
- Credential storage: No service credential is stored for this CLI.
- Never print, persist, or commit credential values.
## Allowed commands (read-only)
- `gitleaks detect --source . --report-format json --report-path gitleaks.json` — R0: Writes a JSON report of detected secrets without editing files.
- `gitleaks protect --staged --verbose` — R0: Checks pending commit content before it leaves the workstation.
## Commands requiring explicit approval (read-only)
- None recorded.
## Forbidden commands (read-only)
- R1 `vi .gitleaks.toml` — Can hide real leaks and must be reviewed carefully.
## Execution rules
1. Mode boundary: R0 exact commands may be used; R1, R2, and R3 commands are forbidden.
2. Confirm the selected account, project, context, database, namespace, or environment before any command.
3. Prefer structured output using `--report-format json`, `--report-path`.
4. Capture the exact command, exit code, stdout, and stderr separately.
5. A generated prefix policy must prompt unless that exact prefix is explicitly marked suffix-safe; do not infer safety from the executable name.
6. Never broaden credentials or disable safety controls to make a command succeed.
## Official sources
- [Gitleaks documentation](https://gitleaks.io/)
- [Gitleaks documentation source repository](https://github.com/gitleaks/gitleaks)
Verification History and Official Evidence
CLI Finder records documentation review separately from real execution. Installation, help, exit codes, and output cannot be called Verified until they were run.