solocrawl AGENTS.md

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

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/hlavacm/solocrawl/agents-md
Clone the repo
git clone --depth 1 https://github.com/hlavacm/solocrawl

Made for: Codex, OpenCode.

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. 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.

ModelPer sessionOnce invoked
Fable 5 $0.00647 $0.00647
Opus 5 $0.00324 $0.00324
Sonnet 5 $0.00129 $0.00129
Haiku 4.5 $0.00065 $0.00065

Measured 2d ago against content hash 5be45871ec7f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 2d 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. 2d 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 2mo ago), licensed MIT. It adds 647 tokens to every session, about $0.0032 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-31.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens