zhin: Instructions file for GitHub Copilot

.github/copilot-instructions.md

zhin copilot-instructions.md is an instructions file for GitHub Copilot from zhinjs/zhin. It costs 1,474 tokens per session, scanned A, original, MIT.

Repository instructions for Zhin.js, a TypeScript framework for building plugins and messaging applications. They describe the required plugin structure, architecture, imports, and development workflow.

In plain words
What is it for?
Creating or changing Zhin.js plugins, commands, message handling, and shared packages in the pnpm workspace monorepo.
Why use it?
They prevent agents from using outdated APIs or bypassing the framework’s message-sending and plugin conventions. A monorepo is one repository containing multiple related packages or projects.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions CLAUDE.md; mentions AGENTS.md.

This is zhinjs/zhin's own configuration. It tells GitHub Copilot how to work on zhin 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 zhin configures →

Reuse

Borrowing it

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

Made for: 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 zhin copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/zhinjs/zhin/copilot-instructions/github.svg)](https://agentmods.dev/instructions/zhinjs/zhin/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/zhinjs/zhin/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/zhinjs/zhin/copilot-instructions/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 zhin copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/zhinjs/zhin/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/zhinjs/zhin/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,474 This file is loaded in full into every session.
When invoked 1,474 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.01474 $0.01474
Opus 5.5 $0.00590 $0.00590
Sonnet 5.5 $0.00295 $0.00295
Haiku 4.5 $0.00147 $0.00147

Measured 18d ago against content hash 088232b75920, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

zhin 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 18d 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 · 122 lines

How it starts

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

Zhin.js Copilot Instructions

优先阅读根目录 AGENTS.md。它是仓库级入口。

Plugin Runtime 为准。 新插件只用 definePlugin + 约定目录(defineCommand 等)。
禁止教 / 写 usePlugin()、MessageCommand、bootstrapNode / zhin.js/node。
插件创作面:.github/instructions/zhin-plugin.instructions.md
标准流程:skill zhin-plugin-standard-development
迁移旧代码:skill migrate-zhin-plugin-runtime

常驻约束

  • pnpm workspace monorepo,不用 git submodule。
  • TypeScript 本地相对导入必须带 .js 扩展名。
  • 新插件:plugin.ts default-export definePlugin();能力按目录发现。
  • IM 出站:Message.$reply / Adapter.sendMessage → renderSendMessage → before.sendMessage → Endpoint;禁止旁路。
  • 分层:basic → kernel → ai → core → agent → zhin(basic/cli 可为 composition root)。
  • 改架构前读 docs/concepts/architecture.md、docs/contributing/repo-structure.md。

最小创作面示例

// plugin.ts
import { definePlugin } from 'zhin.js';

export default definePlugin({
  name: 'my-plugin',
  metadata: { displayName: 'My Plugin' },
  setup(context) {
    context.lifecycle.add(() => { /* cleanup */ });
  },
});
// commands/hello/[name]/index.ts — 路径即路由,类型在 params 中声明
import { defineCommand } from 'zhin.js/command';

export default defineCommand({
  description: '打招呼',
  params: {
    name: { type: 'string', description: '名字' },
  },
  execute({ params }) {
    return `你好,${params.name}!`;
  },
});

单文件 demo:examples/single-file-bot/bot.ts(setup({ addCommand }))。

约定目录

目录 API
commands/**/*/index.ts defineCommand()
middlewares/*/index.ts defineMiddleware()
handlers/<name>/index.ts defineHandler()
components/*/index.tsx defineComponent()
tools/<name>/index.ts defineAgentTool()
hooks/<name>/index.ts defineHook()
mcps/<name>/index.ts defineMcp()
schedules/<name>/index.ts defineSchedule()
agents/<agent>/tools/<name>/index.ts Agent-private defineAgentTool()
skills/<skill>/tools/<name>/index.ts Skill-private defineAgentTool()
agents/<agent>/skills/<skill>/tools/<name>/index.ts Agent-Skill-private defineAgentTool()
pages/*/index.tsx definePage()
skills/<name>/SKILL.md Skill
agents/<name>/agent.json Agent 元数据;同目录包含 system.md、boundaries.md、conventions.md

Read the full file on GitHub · 122 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. 18d ago Changed · +66 tokens per session 088232b75920
  2. 1mo ago Changed · +9 lines · +252 tokens per session 48972e0fbf8b
  3. 2mo ago First seen · 113 lines · 1,156 tokens per session scan A 08ec8cfdd5df

Subscribe to this mod's changes

zhin copilot-instructions.md is an instructions file published in the GitHub repository zhinjs/zhin (136 stars, last pushed today), licensed MIT. It adds 1,474 tokens to every session, about $0.0059 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,731 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