zhin: Instructions file for Codex

AGENTS.md

zhin AGENTS.md is an instructions file for Codex, OpenCode from zhinjs/zhin. It costs 4,738 tokens per session, scanned A, original, MIT.

A guide for coding agents working in the Zhin.js repository, a TypeScript framework for bots that communicate through messaging channels. It explains the project structure, technology choices, architecture, and which files to read first.

In plain words
What is it for?
It is for orienting agents before framework or plugin work, understanding the pnpm workspace, locating relevant documentation, and choosing the right project conventions.
Why use it?
It gives an agent enough project context to make changes in the correct packages and follow the repository’s one-way dependency and plugin rules.

Instructions file for CodexOpenCode

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

This is zhinjs/zhin's own configuration. It tells Codex and OpenCode 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/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/zhinjs/zhin

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 zhin AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/zhinjs/zhin/agents-md"><img src="https://agentmods.dev/badge/instructions/zhinjs/zhin/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 4,738 This file is loaded in full into every session.
When invoked 4,738 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.04738 $0.04738
Opus 5.5 $0.01895 $0.01895
Sonnet 5.5 $0.00948 $0.00948
Haiku 4.5 $0.00474 $0.00474

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

Security

Grade A, and why

zhin 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 13d 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 · 177 lines

How it starts

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

Zhin.js Agent Guide

本文件是本仓库给 AI 编码代理的最小入口。详细说明尽量链接到现有文档,不在这里重复展开。

项目概览

Zhin.js 是 TypeScript 多通道 IM Bot 框架(私聊、群聊、记忆、定时、通知),定位是生活/工作助手 Bot——不是 Cursor / Claude Code 类 coding agent。核心特性:插件热重载、Sandbox、Remote Console、可选 AI Agent 栈。

  • 版本:1.1.x 稳定线。默认安装仅 IM 核心(production node_modules <10MB),AI 按需加装 @zhin.js/agent + zod + ai + 所选 @ai-sdk/*(ADR 0019 安装分层)。
  • 这是 pnpm workspace monorepo(pnpm 9,pnpm-workspace.yaml 为准),构建编排用 turbo。
  • Node 版本要求:>=22.19.0(@zhin.js/ai 依赖的 undici 8 不支持更低版本)。
  • 发布流:changesets(pnpm release 记 changeset,pnpm bump 升版本,pnpm pub 发布)。

先读哪些文件

按这个顺序建立心智模型:

  1. docs/concepts/architecture.md
  2. docs/concepts/plugin-model.md
  3. docs/contributing/repo-structure.md
  4. README.md
  5. 与当前改动最近的包 README 或 docs 页面
  6. 符号/调用链速查:.codegraph/MEMORY.md(CodeGraph 本地索引,需先 codegraph init;不入库)

如果任务属于插件实现,再读 .github/instructions/zhin-plugin.instructions.md。

仓库结构与技术栈

  • 全仓库 TypeScript(ESM),测试 Vitest,Lint ESLint 10 + typescript-eslint,构建产物经 turbo 并行。
  • workspace 覆盖:basic/*、packages/im/*、packages/console/*、packages/toolkit/*、packages/host/*、packages/game-kit、plugins/{adapters,features,games,services,utils}/*、examples/*、docs。
  • basic/:基础层(cli / database / logger / schedule / schema)。
  • packages/im/:IM 核心层(adapter、agent、ai、command、component、config-file、core、feature-kit、isolate、kernel、mcp-feature、middleware、plugin-runtime、runtime、skill、tool、zhin 等子包)。
  • packages/host/:Host 运行时(http / mcp / a2a;legacy router / api 插件包已删除,Console Host 由 basic/cli 装配)。
  • packages/console/:Remote Console(Host 只提供 API,UI 在 console.zhin.dev)。
  • packages/toolkit/:create-zhin(pnpm create zhin-app)、scaffold-wizard(配置向导)、components(纯 JSX 样式组件)、tailwind(静态工具类)、html-renderer(Shotium)、speech。
  • plugins/adapters/:平台适配器(Sandbox / QQ / ICQQ / NapCat / OneBot11·12 / Discord / Telegram / Slack / KOOK / 钉钉 / 飞书 / GitHub / Email / 企微 / LINE / Satori 等)。
  • examples/:参考实现,见下方「示例分层」。
  • 可选 Remote UI submodule:zhin-console/。

Read the full file on GitHub · 177 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. 13d ago Changed · +1 lines · +74 tokens per session ffc7c38141ff
  2. 16d ago Changed · +102 tokens per session 5310be2a6b8a
  3. 18d ago Changed · +2 lines · +260 tokens per session e9025607cc5f
  4. 1mo ago Changed · +10 lines · +329 tokens per session 2b779730fc49
  5. 1mo ago Changed · +10 tokens per session 846f8a3676f7
  6. 2mo ago First seen · 164 lines · 3,963 tokens per session scan A 91706f45de43

Subscribe to this mod's changes

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