What is telodocs AGENTS.md?

Project instructions for telodocs, a tool for creating and running documentation websites and packages.

Installing dependencies, building, testing, and changing the telodocs code or its documentation scaffold.

They give coding agents the project’s setup commands, file layout, and coding rules.

How teloset/telodocs configures Codex and OpenCode

Reuse

Borrowing it

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

Clone the repo

git clone --depth 1 https://github.com/teloset/telodocs

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

Your own site

<a href="https://agentmods.dev/instructions/teloset/telodocs/agents-md"><img src="https://agentmods.dev/badge/instructions/teloset/telodocs/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/teloset/telodocs/agents-md"><img src="https://agentmods.dev/badge/instructions/teloset/telodocs/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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

When invoked 871 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.00871	$0.00871
Opus 5.5	$0.00348	$0.00348
Sonnet 5.5	$0.00174	$0.00174
Haiku 4.5	$0.00087	$0.00087

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

Security

Grade A, and why

telodocs 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 · 85 lines

How it starts

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

AGENTS.md

Instructions for AI coding agents working on the telodocs npm package (server, CLI, and scaffold template).

User-facing documentation projects scaffolded via telodocs new include their own AGENTS.md with content-authoring guidance — see template/AGENTS.md.

Setup commands

Install dependencies: npm install
Build: npm run build
Run tests: npm test
Local CLI (after build): node dist/cli/index.js new my-docs --no-git

Project layout

Path	Purpose
`src/cli/`	CLI commands (`new`, `dev`, `start`)
`src/server/`	NestJS server — docs API, MCP, search, auth
`src/web/`	React docs UI (Vite, feature-based, React Query)
`template/`	Files copied by `telodocs new` (docs-only scaffold)
`test/`	Vitest tests

Scaffolded projects contain docs/, .env, .env.example, .gitignore, README.md, and AGENTS.md.

Code conventions

TypeScript strict mode; NestJS module/service/controller patterns under src/server/
Keep files under ~200 lines where practical — split into focused services
Match existing naming: *.service.ts, *.controller.ts, *.module.ts
Run npm test before finishing; fix failures

Changing the scaffold

When editing template/:

Update SCAFFOLD_ENTRIES in src/cli/commands/new.ts if adding new top-level scaffold files
Update test/cli/new.spec.ts if scaffold shape changes
Rebuild and run the CLI scaffold test

Documentation authoring instructions for end users live in template/AGENTS.md and template/docs/.

Releases

telodocs is published to npm. Treat every merged change as a release unless the user explicitly says not to bump.

Version bump (required on every change)

Bump version in package.json
Keep package-lock.json root/packages[""] version in sync (run npm install if needed — it rewrites a stale lockfile version)
Prefer patch for incremental fixes/features (0.4.0 → 0.4.1); use minor / major when the change warrants it
Include the bump in the same PR as the change
Commit message style: Release vX.Y.Z with <short summary>.

Read the full file on GitHub · 85 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 · 85 lines · 871 tokens per session scan A a440eeee895f

Subscribe to this mod's changes

telodocs AGENTS.md is an instructions file published in the GitHub repository teloset/telodocs (0 stars, last pushed 3mo ago), licensed MIT. It adds 871 tokens to every session, about $0.0035 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.

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

telodocs: Instructions file for Codex