agentwork AGENTS.md

A repository guide for coding agents, stored in an AGENTS.md file. It explains the project’s rules, safety checks, startup documents, and suggested work steps.

In plain words
What is it for?
Use it to guide agents through planning, execution, review, and commits while following project-specific file-reading, language, temporary-file, and Git rules.
Why use it?
It gives an agent the project context and boundaries before work begins, helping avoid unsafe commands, missed documents, and inconsistent changes.

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

Made for: Codex, OpenCode.

Per session 750 This file is loaded in full into every session.
When invoked 750 The same file — it is already loaded in full.
Security scan C 1 finding. 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.00750 $0.00750
Opus 5 $0.00375 $0.00375
Sonnet 5 $0.00150 $0.00150
Haiku 4.5 $0.00075 $0.00075

Measured 2d ago against content hash befefd2d9ded, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade C, and why

agentwork AGENTS.md scanned grade C with 1 finding 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 2d 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.

Recursive force deletehighDestructive command

rm -rf with a variable or a broad path is one typo away from removing the wrong tree.

- `rm -rf`、`git push --force`、`git reset --hard`、数据库删除/重建
AGENTS.md · 57 lines

What it actually says

AGENTS.md

本项目使用 agentwork 作为工作流基础层。

本仓库协作规范集中在 .shared/,此文件为启动时必读的引导规则。

启动入口仅承载稳定入口和长期约束;当前任务上下文写入 .shared/session/*.md,并且只在显式引用时加载。

核心安全约束(必须遵守)

高风险操作前必须确认

  • rm -rfgit push --forcegit reset --hard、数据库删除/重建
  • 执行前说明风险 → 给替代方案 → 确认用户意图

自引入错误可直接修复:语法错误、格式问题、编译错误。

启动必读

  1. .shared/constraints/coding-style.md
  2. .shared/constraints/destructive-operations.md
  3. .shared/constraints/placeholder-naming.md
  4. .shared/project/index.md
  5. .shared/INDEX.md

基本规则

  • 默认使用简体中文沟通
  • 仅在用户明确要求或必须原样输出代码/命令时使用其他语言
  • 高风险操作必须确认
  • 不自动加载 .shared/session/*
  • 不要预读全部 .shared/project/*.md;当任务涉及具体项目或目录时,先根据 .shared/project/index.md 读取对应的轻量 project 文档
  • 当第一次确定将读取或修改的目标路径后,必须立即对照 .shared/project/index.md 的读取映射;若命中条目,先读取对应 project/*.md 再继续工作;若目标路径扩大,重新对照一次
  • 预览未知或可能很大的命令输出时,优先使用 .shared/scripts/command-preview.sh -- COMMAND ...,避免直接把大段输出送入上下文
  • 临时工件统一写入 .tmp/
  • 可选工具默认不预装,按项目约定单独引入
  • Git index(staged 区)是用户的提交和 review 边界;未经明确要求,不改变 staged 区
  • 优先写项目级配置,避免污染全局配置
  • source repo 的安装入口:install-bootstrap.pyinstall-tool.py

工作流起步建议

  • 需求不清晰、边界模糊:先 /brain
  • 已有方向、需要拆执行步骤:先 /plan
  • 开始做当前批次工作:用 /exec
  • 一轮工作完成后:先 /review,再决定是否 /commit

复杂任务

  • 当任务涉及多步骤/跨文件/需要调研时,参考:.shared/patterns/session-workflow.md
  • 如需确认跨平台(Codex / Claude / OpenCode / Cursor)能力边界、资料可信度与冲突回退流程,参考:.shared/patterns/platform-adapter.md

代码导航默认策略

  • 处理当前项目内的代码任务时,优先遵循:.shared/patterns/semantic-navigation.md
  • 对 definition / references / symbols / rename-preview / diagnostics 这类语义查询,助手应默认使用对应语义导航能力
  • 路径默认使用当前项目内的相对路径,不写用户目录或绝对工程路径示例
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. 2d ago First seen · 57 lines · 750 tokens per session scan C befefd2d9ded

Subscribe to this mod's changes

agentwork AGENTS.md is an instructions file published in the GitHub repository zhagqn/agentwork (79 stars, last pushed 11d ago), licensed MIT. It adds 750 tokens to every session, about $0.0037 per session on Opus 5. A static security scan graded it C with 1 finding (recursive force delete). 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

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

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

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

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

next.js 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