zhin AGENTS.md

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

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/zhinjs/zhin/agents-md
Clone the repo
git clone --depth 1 https://github.com/zhinjs/zhin

Made for: Codex, OpenCode.

Per session 3,963 This file is loaded in full into every session.
When invoked 3,963 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.03963 $0.03963
Opus 5 $0.01982 $0.01982
Sonnet 5 $0.00793 $0.00793
Haiku 4.5 $0.00396 $0.00396

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

How it starts

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

  • 版本:4.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 版本要求:^20.19.0>=22.12.0
  • 发布流: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-kitplugins/{adapters,features,games,services,utils}/*examples/*docs
  • basic/:基础层(cli / database / logger / schedule / schema)。
  • packages/im/:IM 核心层(adapter、agent、ai、command、component、config-yaml、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(配置向导)、satori、html-renderer、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 · 164 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. 3d 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 (135 stars, last pushed 6d ago), licensed MIT. It adds 3,963 tokens to every session, about $0.0198 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.