What is pentest-ai AGENTS.md?

A contributor guide for pentest-ai, a security-testing project, with commands and layout notes for building, testing, checking code quality, and understanding its folders.

Installing development dependencies, running tests, linting, formatting, checking types, using optional components, and locating important project files.

It gives coding agents a shared set of project rules so they can work consistently with the repository.

pentest-ai AGENTS.md — Instructions file for Codex and OpenCode by 0xSteph: A contributor guide for pentest-ai, a security-testing project,

About the project

ptai is an AI tool for authorized web application penetration testing that keeps findings as candidates until machine-controlled checks reproduce the exploit and create replayable proof. Security testers and bug bounty researchers use it with coding-agent clients or its standalone CLI to verify vulnerabilities.

0xSteph/pentest-ai · 1,650 stars · on GitHub

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add instructions/0xsteph/pentest-ai/agents-md

Clone the repo

git clone --depth 1 https://github.com/0xSteph/pentest-ai

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/0xsteph/pentest-ai/agents-md.svg)](https://agentmods.dev/instructions/0xsteph/pentest-ai/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/0xsteph/pentest-ai/agents-md"><img src="https://agentmods.dev/badge/instructions/0xsteph/pentest-ai/agents-md.svg" alt="Measured on agentmods" height="20"></a>

Per session 793 This file is loaded in full into every session.

When invoked 793 The same file — it is already loaded in full.

Security scan A 0 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.00793	$0.00793
Opus 5	$0.00396	$0.00396
Sonnet 5	$0.00159	$0.00159
Haiku 4.5	$0.00079	$0.00079

Measured yesterday against content hash aed38a4a9ff8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

pentest-ai AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 78 lines

How it starts

The opening of the file, as written. The whole thing — 78 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Agent guide for pentest-ai

For AI coding agents (Claude Code, Cursor, Copilot, Codex CLI, Devin, Windsurf, Gemini CLI, Aider) and human contributors. Briefly: build, test, style, layout. Defer to README.md for product info.

Build

pip install -e .[dev]

Optional surfaces (install only what you'll touch):

pip install -e .[litellm,api,menu,browser,tracing,stealth,cloud]

Browser tests need: playwright install chromium. Stealth crawler needs: scrapling install --force.

Test

pytest                         # full suite
pytest tests/test_cli.py       # one file
pytest -k "name_substring"     # by keyword

asyncio_mode = "auto" is set in pyproject.toml. Use pytest-asyncio patterns; do not call asyncio.run inside tests.

Lint, types, format

ruff check .          # lint
ruff format .         # format
mypy .                # types (non-strict; see [tool.mypy] in pyproject.toml)

Pre-commit hooks: pre-commit install once, then they run on every commit.

Layout

Path	Purpose
`cli/`	`ptai` CLI entrypoint, menu, install wizard, MCP setup
`mcp_server/`	FastMCP server, exposes tools to Claude Code, Cursor, etc.
`api/`	FastAPI HTTP surface (alternative to MCP for non-MCP clients)
`engine/`	Orchestrator, scope, auth, findings DB, telemetry, HITL, playbooks
`agents/`	`BaseAgent` orchestrator classes (18 dirs under `agents/`)
`tools/`	Wrappers — all of them in `tools/registry.py`
`playbooks/`	YAML multi-step engagement playbooks
`tests/`	pytest suite
`benchmarks/`	reproducible solve-rate measurements
`docs/`	user-facing documentation

Conventions

Python ≥ 3.10. Tested on 3.10 – 3.14 (requires-python = ">=3.10,<3.15").
Add tests for new code; mirror module structure in tests/.
New tool wrappers register in tools/registry.py (there are no per-category packages under tools/).
New agents subclass agents/base.py:BaseAgent.
160-char line length (ruff config).
No secrets in code or tests. .env* is gitignored.

Read the full file on GitHub · 78 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

yesterday Changed · -30 tokens per session aed38a4a9ff8
5d ago First seen · 78 lines · 823 tokens per session scan A 5c846bc2059b

Subscribe to this mod's changes

pentest-ai AGENTS.md is an instructions file published in the GitHub repository 0xSteph/pentest-ai (1,650 stars, last pushed 2d ago), licensed MIT. It adds 793 tokens to every session, about $0.0040 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

ai-security bug-bounty claude ctf cybersecurity hacking-tools

numasec AGENTS.md

AGENTS.md instructions for FrancescoStabile/numasec, covering numasec agent guide, operating rules, branches, product direction and product messaging direction.

FrancescoStabile/numasec · 2,610 tokens

stride-gpt AGENTS.md

AGENTS.md instructions for mrwadams/stride-gpt, covering agents.md, what this project is, repository layout, how the agentic analysis works and progressive disclosure pattern.

mrwadams/stride-gpt · 4,122 tokens

Cybermes AGENTS.md

Instructions for Zyrexnn/Cybermes, covering 🛡️ cybermes master operational directives (agents.md), 1. 🎯 persona & core mission, 2. ⚡ core operational principles, 3. 📁 strict target-scoped workspace & deliverables and mandatory rules for file creation.

Zyrexnn/Cybermes · 1,549 tokens

pentest-ai AGENTS.md