novel-writer: Instructions file for Claude Code

.github/copilot-instructions.md

novel-writer copilot-instructions.md is an instructions file for Claude Code, GitHub Copilot from wordflowlab/novel-writer. It costs 1,183 tokens per session, scanned A, original, MIT.

A repository guide for Novel Writer, a command-line tool and template collection for creating Chinese novels with Spec-Driven Development, a method of planning software through written specifications before implementation.

In plain words
What is it for?
Use it when changing the CLI, build process, project initialization, agent templates, generated command files, or the specification and story directories.
Why use it?
It explains the important files, project layout, build commands, generated agent instructions, and conventions so changes can be made without guessing how the tool works.

Instructions file for Claude CodeGitHub Copilot

Written for Claude Code and GitHub Copilot: $ARGUMENTS substitution, but also a Copilot instructions file. Also seen: reads .claude/ paths; mentions AGENTS.md; mentions OpenCode.

This is wordflowlab/novel-writer's own configuration. It tells Claude Code and GitHub Copilot how to work on novel-writer 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 novel-writer configures →

Reuse

Borrowing it

Nothing to install: this file belongs to wordflowlab/novel-writer. 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/wordflowlab/novel-writer/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/wordflowlab/novel-writer

Made for: Claude Code, GitHub Copilot.

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 novel-writer copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/wordflowlab/novel-writer/copilot-instructions.svg)](https://agentmods.dev/instructions/wordflowlab/novel-writer/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/wordflowlab/novel-writer/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/wordflowlab/novel-writer/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,183 This file is loaded in full into every session.
When invoked 1,183 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.01183 $0.01183
Opus 5 $0.00592 $0.00592
Sonnet 5 $0.00237 $0.00237
Haiku 4.5 $0.00118 $0.00118

Measured 8d ago against content hash 68fcab4527eb, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

novel-writer copilot-instructions.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 8d 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.

.github/copilot-instructions.md · 66 lines

How it starts

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

Quick context for AI coding agents

This repository is an AI-first CLI tool and template collection for creating Chinese novels using a Spec-Driven Development (SDD) workflow. Key components:

  • src/cli.ts — primary CLI entry (commands: init, upgrade, etc.). Look here for how projects are bootstrapped and how AI agent types map to filesystem layout.
  • package.json — build/dev scripts. npm run build compiles TypeScript; npm run build:commands generates per-agent command files from templates.
  • dist/* — build artifacts containing pre-generated agent command sets (copied into user projects by init).
  • .specify/, spec/, stories/ — runtime project layout produced by novel init.
  • other/spec-kit/AGENTS.md — long-form guidance and agent conventions; use it as authoritative reference when adding new agents.

Keep instructions short and concrete: reference the exact file and function you changed and prefer small, self-contained edits.

High-level architecture notes

  • The CLI bootstraps a project by copying built artifacts from the package root (dist/<agent>) into the target project and creating .specify/* scaffolding (src/cli.ts, copy logic around sourceMap).
  • Agent configuration is agent-centric: directories like .claude/commands, .gemini/commands, .cursor/commands are created and populated during novel init.
  • Agent metadata and behavioral decisions are centered in the Spec Kit patterns documented in other/spec-kit/AGENTS.md. When adding agents, prefer updating AGENT_CONFIG (in the spec-kit implementation) and the scripts/* update tooling.

Common developer workflows (how to run / build / test)

  • Local development: npm run dev (runs tsx src/cli.ts) — fast way to iterate on CLI behavior without building.
  • Build: npm run build (TypeScript -> dist/), then npm run build:commands to regenerate per-agent command files. prepare and prepublishOnly call both.
  • If an init action warns that a dist artifact is missing, run npm run build:commands and re-run the command.

Read the full file on GitHub · 66 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. 8d ago First seen · 66 lines · 1,183 tokens per session scan A 68fcab4527eb

Subscribe to this mod's changes

novel-writer copilot-instructions.md is an instructions file published in the GitHub repository wordflowlab/novel-writer (940 stars, last pushed 10mo ago), licensed MIT. It adds 1,183 tokens to every session, about $0.0059 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

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

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

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

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