Kokoro-FastAPI AGENTS.md

Kokoro-FastAPI AGENTS.md is an instructions file for Codex, OpenCode from remsky/Kokoro-FastAPI. It costs 822 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

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/remsky/kokoro-fastapi/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.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.svg" alt="Measured on agentmods" height="20"></a>
Per session 822 This file is loaded in full into every session.
When invoked 822 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.00822 $0.00822
Opus 5 $0.00411 $0.00411
Sonnet 5 $0.00164 $0.00164
Haiku 4.5 $0.00082 $0.00082

Measured 4d ago against content hash 1aa63ebd5910, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 4d 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 · 48 lines

How it starts

The opening of the file, as written. The whole thing — 48 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.

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: ruff format . then 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).

Conventions

Read the full file on GitHub · 48 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. 4d 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,402 stars, last pushed today), licensed Apache-2.0. It adds 822 tokens to every session, about $0.0041 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-30.