show-me-the-story: Instructions file for Codex

AGENTS.md

show-me-the-story AGENTS.md is an instructions file for Codex, OpenCode from Nigh/show-me-the-story. It costs 4,096 tokens per session, scanned A, original, MIT.

A project instruction document for an AI novel-writing application called Show Me the Story. It describes the project's structure, setup commands, build process, and rules for keeping documentation current.

In plain words
What is it for?
Explaining how to build, run, and develop the application, including its ports, directories, languages, frontend tools, multilingual setup, and required checks after changes.
Why use it?
It gives coding agents and developers a shared reference for how the Go backend, Svelte frontend, embedded build, tests, and story projects fit together.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is Nigh/show-me-the-story's own configuration. It tells Codex and OpenCode how to work on show-me-the-story 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 show-me-the-story configures →

Reuse

Borrowing it

Nothing to install: this file belongs to Nigh/show-me-the-story. 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/Nigh/show-me-the-story/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/Nigh/show-me-the-story

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 show-me-the-story AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/nigh/show-me-the-story/agents-md/github.svg)](https://agentmods.dev/instructions/nigh/show-me-the-story/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/nigh/show-me-the-story/agents-md"><img src="https://agentmods.dev/badge/instructions/nigh/show-me-the-story/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 show-me-the-story AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/nigh/show-me-the-story/agents-md"><img src="https://agentmods.dev/badge/instructions/nigh/show-me-the-story/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 4,096 This file is loaded in full into every session.
When invoked 4,096 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.04096 $0.04096
Opus 5 $0.02048 $0.02048
Sonnet 5 $0.00819 $0.00819
Haiku 4.5 $0.00410 $0.00410

Measured today against content hash e4e9ceff6641, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

show-me-the-story 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 · 173 lines

How it starts

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

AGENTS.md — AI 小说写手项目指南

修改代码、配置、前端、提示词或构建流程后,必须同步更新本文件;只记录长期有效的约束与当前架构,不记录单次修复历史或逐函数清单。

项目概览

  • 单二进制 Go Web 应用;Go 后端只使用标准库,前端产物与内置 Skill 通过 embed.FS 嵌入。
  • Go 1.25.1,模块 showmethestory;默认端口 :48090,可用 PORT 覆盖。
  • 前端:Vite 5、Svelte 4、Tailwind CSS 4、DaisyUI 5、@xianii/design-system;Playwright 仅使用系统 Google Chrome 生成 README 截图。
  • 当前项目格式固定为 v4;项目默认保存在程序目录的 storys/<项目名>/
  • 项目语言 zh / en 决定模型提示词、正文和内置 Skill;UI 语言由浏览器独立切换。
  • 默认英文入口为 README.md,中文入口为 README.zh.md;语言导航保持独立的首行链接列表,便于继续增加语言。详细流程维护于 docs/guide.zh.mddocs/guide.en.md,按创作顺序提供双语步骤与故障排查;许可证为 MIT。

常用命令

task build                 # npm install + 前端构建 + Go 二进制
task build:go              # 只构建 Go;要求 frontend/dist 已存在
task dev                   # 构建并启动后端
task dev:frontend          # Vite 开发服务器 :5173,代理 /api 到 :48090
task screenshots           # 用固定离线样例重建 README 截图

go build ./...
go test ./...
go vet ./...
cd frontend && npm run build

node frontend/src/lib/projectRestore.check.js
node frontend/src/lib/forceGraphLayout.check.js
cd frontend && npm run check # 所有前端回归检查

提交前至少运行 go build ./...go test ./...go vet ./...;修改前端时再运行前端构建及受影响的 .check.js

PR 与 main/v4 推送通过同一检查工作流在 Linux/Windows 原生执行构建、测试及 vet;Linux 额外运行 race 检查。发布复用该工作流,检查成功后才生成发布产物。

架构边界

main.go
└── internal/httpapi
    ├── internal/agent
    │   └── internal/story
    └── internal/story
        ├── internal/llm
        ├── internal/config
        ├── internal/sse
        ├── internal/i18n
        ├── internal/prose
        └── internal/fsutil
  • main.go:程序目录、API 配置、开发日志、嵌入前端和服务装配。
  • internal/httpapi/:路由、请求校验、项目管理、异步任务互斥、SSE 和本地化错误。
  • internal/agent/:助理循环、工具解析与执行、危险操作确认。
  • internal/story/:大纲、写作、事实与设定、伏笔、导入、Skill、会话、校订等领域逻辑。
  • internal/llm/:OpenAI 兼容客户端、流式完整性、重试、token 统计、JSON 提取。
  • internal/config/:API/项目配置和中英默认提示词。
  • internal/sse/i18n/prose/fsutil/devlog/:领域无关基础能力。
  • frontend/src/:Svelte 页面、组件、stores、API/SSE/i18n;生产产物仅在 frontend/dist/

依赖必须保持单向:httpapi → agent → story → 基础包sse 的事件负载保持 any,不得反向依赖领域包。不要恢复已废弃的根目录 static/ 单页实现。

Read the full file on GitHub · 173 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 · -573 lines · -20,288 tokens per session e4e9ceff6641
  2. 11d ago First seen · 746 lines · 24,384 tokens per session scan A abab514a4557

Subscribe to this mod's changes

show-me-the-story AGENTS.md is an instructions file published in the GitHub repository Nigh/show-me-the-story (567 stars, last pushed today), licensed MIT. It adds 4,096 tokens to every session, about $0.0205 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.

Related

Other instructions, from other repositories

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,296 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,153 tokens

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

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,469 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