What is agentscribe AGENTS.md?

Repository instructions for agentscribe, a command-line tool and library that creates several AI coding-instruction files from one AGENTS.md source file. They cover setup, commands, code conventions, testing, and restrictions.

Use them when changing agentscribe, running its tests or linting, editing the source instructions, or synchronizing files for tools such as Claude, Cursor, and Copilot.

They give coding agents one maintained source of project rules and help keep generated instruction files consistent.

How Lucabiz/agentscribe configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to Lucabiz/agentscribe. 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/Lucabiz/agentscribe/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/Lucabiz/agentscribe

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/lucabiz/agentscribe/agents-md/github.svg)](https://agentmods.dev/instructions/lucabiz/agentscribe/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/lucabiz/agentscribe/agents-md"><img src="https://agentmods.dev/badge/instructions/lucabiz/agentscribe/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/lucabiz/agentscribe/agents-md"><img src="https://agentmods.dev/badge/instructions/lucabiz/agentscribe/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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

When invoked 617 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.

Model	Per session	Once invoked
Fable 5.1	$0.00617	$0.00617
Opus 5.5	$0.00247	$0.00247
Sonnet 5.5	$0.00123	$0.00123
Haiku 4.5	$0.00062	$0.00062

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

Security

Grade A, and why

agentscribe 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 · 59 lines

How it starts

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

agentscribe

Guidance for AI coding agents working in this repository. This file is the single source of truth. The tool-specific files (CLAUDE.md, .cursor/rules/, .github/copilot-instructions.md) are generated from it by agentscribe sync — never edit them by hand.

Overview

agentscribe is a small CLI + library that generates tool-specific AI instruction files (CLAUDE.md, Cursor rules, Copilot instructions, ...) from a single AGENTS.md, and validates that source. The code lives under src/agentscribe/:

config.py — load configuration from agentscribe.toml or [tool.agentscribe].
source.py — parse the source and apply agentscribe:only/except/ignore scoping.
targets.py — the registry of output files and how each is formatted.
sync.py — plan, write, and drift-check target files.
lint.py — conservative static checks over the source.
detect.py / templates.py — power agentscribe init.
cli.py — argparse front end.

Setup & commands

Task	Command
Install (editable, with dev deps)	`pip install -e ".[dev]"`
Run tests	`pytest`
Lint	`ruff check .`
Format	`ruff format .`
Run the tool	`agentscribe <command>` (e.g. `agentscribe sync`)

Code style & conventions

Target Python 3.9+. Every module starts with from __future__ import annotations so built-in generics (list[str]) are safe in annotations.
Keep runtime dependencies at zero (the only exception is the tomli backport on Python < 3.11). Do not add dependencies without strong justification.
Match the surrounding style; keep functions small and pure where possible.
Generated output must stay deterministic: LF line endings, stable ordering.

Testing

Run the full suite with pytest before considering a change done.
Add or update tests in tests/ for any behavior you change.
Every CLI command and lint rule should have coverage.

Do not

Do not commit secrets, credentials, or .env files. The linter flags common token shapes; do not add real tokens even as examples.
Do not hand-edit generated files (CLAUDE.md, .cursor/rules/agentscribe.mdc, .github/copilot-instructions.md); edit this file and run agentscribe sync.
Do not introduce new third-party runtime dependencies.

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

2mo ago First seen · 59 lines · 617 tokens per session scan A de5ea5370296

Subscribe to this mod's changes

agentscribe AGENTS.md is an instructions file published in the GitHub repository Lucabiz/agentscribe (5 stars, last pushed 2mo ago), licensed MIT. It adds 617 tokens to every session, about $0.0025 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.

Building agents Writing and docs agents agents-md ai claude cli codex

agentscribe AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
agentscribe AGENTS.mdLucabiz/agentscribe	Instructions file	5	2mo ago	MIT	A	617	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

agentscribe: Instructions file for Codex