solocrawl: Instructions file for Codex

AGENTS.md

solocrawl AGENTS.md is an instructions file for Codex, OpenCode from hlavacm/solocrawl. It costs 647 tokens per session, scanned A, original, MIT.

Repository instructions for SoloCrawl, a Python package, covering its layout, commands, coding conventions, and testing rules.

In plain words
What is it for?
Use them when developing SoloCrawl, running its CLI or MCP server, formatting and type-checking code, or running its tests.
Why use it?
They give a coding agent the project-specific context needed to make changes that fit the repository and run the expected checks.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is hlavacm/solocrawl's own configuration. It tells Codex and OpenCode how to work on solocrawl itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything solocrawl configures →

Reuse

Borrowing it

Nothing to install: this file belongs to hlavacm/solocrawl. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/hlavacm/solocrawl/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/hlavacm/solocrawl

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.

agentmods badge for solocrawl AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/hlavacm/solocrawl/agents-md/github.svg)](https://agentmods.dev/instructions/hlavacm/solocrawl/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/hlavacm/solocrawl/agents-md"><img src="https://agentmods.dev/badge/instructions/hlavacm/solocrawl/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for solocrawl AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/hlavacm/solocrawl/agents-md"><img src="https://agentmods.dev/badge/instructions/hlavacm/solocrawl/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 647 This file is loaded in full into every session.
When invoked 647 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00647 $0.00647
Opus 5.5 $0.00259 $0.00259
Sonnet 5.5 $0.00129 $0.00129
Haiku 4.5 $0.00065 $0.00065

Measured 2mo ago against content hash 5be45871ec7f, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

solocrawl 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 2mo ago.

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 · 55 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

SoloCrawl is a Python 3.14+ package using a src/ layout. Core library code lives in src/solocrawl/core/, with subpackages for fetch, extract, search, packages, and proxy. CLI adapters are in src/solocrawl/cli/; MCP stdio code is in src/solocrawl/mcp/. Tests live in tests/, examples in examples/, assets in assets/, and design notes in docs/context/.

Keep business logic in core; CLI and MCP code should remain thin serialization and command shells.

Build, Test, and Development Commands

  • python -m venv .venv && source .venv/bin/activate: create a local virtualenv.
  • pip install -e ".[dev]": install the package plus dev tools.
  • solocrawl search "python asyncio" --limit 5: run the CLI after editable install.
  • solocrawl-mcp: start the MCP server on stdio.
  • ruff check . and ruff format --check .: lint and verify formatting.
  • pyright: run static type checking.
  • pytest: run the default test suite, excluding tests marked live.
  • pytest -m live: run optional network smoke tests.

Coding Style & Naming Conventions

Use Ruff formatting with a 100-character line length and Python 3.14 target. Prefer full type hints, especially on public interfaces. Use snake_case for functions and variables, PascalCase for classes, and UPPER_SNAKE for constants. Public functions/classes need short behavior-focused docstrings; MCP tool docstrings must be clear because clients surface them to models.

Async code is the default for network paths. Avoid blocking calls such as requests or time.sleep.

Testing Guidelines

Tests use pytest with pytest-asyncio; test files follow tests/test_*.py. Normal tests should use fixtures or mocked responses instead of the live web. Mark network smoke tests with @pytest.mark.live so they stay out of the default run.

Add tests for provider parsing, graceful degradation, resolver edges, extraction fallbacks, and CLI or MCP behavior when changing those areas.

Read the full file on GitHub · 55 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.

  1. 2mo ago First seen · 55 lines · 647 tokens per session scan A 5be45871ec7f

Subscribe to this mod's changes

solocrawl AGENTS.md is an instructions file published in the GitHub repository hlavacm/solocrawl (2 stars, last pushed 18d ago), licensed MIT. It adds 647 tokens to every session, about $0.0026 per session on Opus 5.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-31.

Related

solocrawl AGENTS.md compared with instructions from other repositories

solocrawl AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
solocrawl AGENTS.mdhlavacm/solocrawlInstructions file218d agoMITA647Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode