Kokoro-FastAPI: Instructions file for Codex

AGENTS.md

Kokoro-FastAPI AGENTS.md is an instructions file for Codex, OpenCode from remsky/Kokoro-FastAPI. It costs 927 tokens per session, scanned A, original, Apache-2.0.

A contributor guide for Kokoro-FastAPI, a service that turns text into spoken audio through an API and web interface. It describes where the API, audio processing, model code, configuration, and web files live.

In plain words
What is it for?
Use it when changing API routes, speech generation, audio streaming, model or voice handling, configuration, or the web interface.
Why use it?
It explains the code layout and project conventions, helping agents find the right files and avoid contribution mistakes such as excessive comments or unsupported style changes.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: reads .claude/ paths; mentions AGENTS.md.

This is remsky/Kokoro-FastAPI's own configuration. It tells Codex and OpenCode how to work on Kokoro-FastAPI 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 Kokoro-FastAPI configures →

About the project

Kokoro-FastAPI is a Dockerized FastAPI service that turns text into speech using the Kokoro-82M model through an OpenAI-compatible API. It is used by developers and self-hosters who need multilingual, multi-speaker speech generation, captions, phonemes, or an optional web interface.

remsky/Kokoro-FastAPI · 5,614 stars · on GitHub

Reuse

Borrowing it

Nothing to install: this file belongs to remsky/Kokoro-FastAPI. 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/remsky/Kokoro-FastAPI/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/remsky/Kokoro-FastAPI

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 Kokoro-FastAPI AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/remsky/kokoro-fastapi/agents-md/github.svg)](https://agentmods.dev/instructions/remsky/kokoro-fastapi/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/remsky/kokoro-fastapi/agents-md"><img src="https://agentmods.dev/badge/instructions/remsky/kokoro-fastapi/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 Kokoro-FastAPI AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/remsky/kokoro-fastapi/agents-md"><img src="https://agentmods.dev/badge/instructions/remsky/kokoro-fastapi/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 927 This file is loaded in full into every session.
When invoked 927 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.00927 $0.00927
Opus 5.5 $0.00371 $0.00371
Sonnet 5.5 $0.00185 $0.00185
Haiku 4.5 $0.00093 $0.00093

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

Security

Grade A, and why

Kokoro-FastAPI 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 today.

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

How it starts

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

AGENTS.md

Guidance for coding agents working on Kokoro-FastAPI. Agent-assisted contributions are welcome, with caveats: - All judgement and accountability falls to the named human contributor as the reviewer. - If the user doesn't demonstrate understanding a change, it's not ready to merge. - Code style here must still match house style. - To the above, explicitly: - wanton em-dash usage is not permitted. - expositionary and excessive commenting is not permitted. - when in doubt, do less. Comments are reserved for decision points, or unexpected gotchas, etc.

The general instructions must also still be followed, same as any contributor, and live in CONTRIBUTING.md.

Task guides for agents live in .claude/skills/, listed in CONTRIBUTING.md.

Layout

  • api/src/routers/ - HTTP endpoints. openai_compatible.py is the main API surface.
  • api/src/services/ - TTS orchestration (tts_service.py), audio encoding and streaming (audio.py, streaming_audio_writer.py), text_processing/ (normalization, phonemization).
  • api/src/inference/ - model backends (kokoro_v1.py), model and voice managers.
  • api/src/core/ - config.py (env-driven settings), paths.py, openai_mappings.json (OpenAI model/voice name mapping).
  • web/ - vanilla JS web player, served by the API. No framework, no build step.
  • docker/{cpu,gpu,rocm}/ - per-accelerator images and compose files. docker-bake.hcl defines the CI build targets.
  • examples/ - standalone samples with their own uv venv. Run uv run from inside examples/, not the root env.

Commands

  • Python tests: uv run pytest (runs api/tests/; integration tests are excluded by default, opt in with -m integration).
  • Format and lint: uv run --only-group lint ruff format . then uv run --only-group lint ruff check . --fix.
  • Web unit tests: npm run test:web. E2e: npm run test:e2e. New unit test files must be imported from web/tests/unit/index.test.mjs; it is a manual registry.
  • Container smoke test: npm run cpu:up (or gpu:up, rocm:up).

Read the full file on GitHub · 51 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. today Changed · +14 tokens per session 2cc677e17364
  2. 1mo ago Changed · +14 tokens per session 330d15a91031
  3. 1mo ago Changed · +2 lines · +30 tokens per session 2a1e38870670
  4. 1mo ago Changed · +1 lines · +47 tokens per session f1d11c8b9420
  5. 2mo ago First seen · 48 lines · 822 tokens per session scan A 1aa63ebd5910

Subscribe to this mod's changes

Kokoro-FastAPI AGENTS.md is an instructions file published in the GitHub repository remsky/Kokoro-FastAPI (5,614 stars, last pushed today), licensed Apache-2.0. It adds 927 tokens to every session, about $0.0037 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-30.

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 · 9,715 tokens

next.js AGENTS.md

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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens