zcf AGENTS.md

zcf AGENTS.md is an instructions file for Codex, OpenCode from UfoMiao/zcf. It costs 633 tokens per session, scanned A, original, MIT.

Repository instructions for zcf, a TypeScript command-line application. They describe its source layout, package-manager commands, tests, documentation, and coding conventions.

In plain words
What is it for?
Use them to develop CLI features, install dependencies, run watch mode, build the package, check TypeScript, lint code, and run Vitest tests.
Why use it?
They tell an agent where code belongs and which commands check types, style, builds, and behavior before changes are considered ready.

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

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/ufomiao/zcf/agents-md.svg)](https://agentmods.dev/instructions/ufomiao/zcf/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/ufomiao/zcf/agents-md"><img src="https://agentmods.dev/badge/instructions/ufomiao/zcf/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 633 This file is loaded in full into every session.
When invoked 633 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.00633 $0.00633
Opus 5 $0.00316 $0.00316
Sonnet 5 $0.00127 $0.00127
Haiku 4.5 $0.00063 $0.00063

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

Security

Grade A, and why

zcf 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 4d 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 · 25 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

Source code lives in src/, with the CLI entry point in src/cli.ts and features split into commands/, config/, utils/, and types/. Shared assets (banners, locale files, templates) are under src/assets/, src/i18n/, and top-level templates/. Generated bundles reside in dist/; avoid editing them directly. Tests mirror the runtime tree inside tests/ (unit/, integration/, and helper fixtures), and documentation resides in docs/ plus localized READMEs.

Build, Test, and Development Commands

  • pnpm install — sync dependencies defined by the workspace catalogs.
  • pnpm dev — run the CLI in watch mode via tsx for rapid iteration.
  • pnpm build — produce the distributable with unbuild.
  • pnpm typecheck — validate TypeScript types without emitting files.
  • pnpm lint / pnpm lint:fix — run ESLint with the shared @antfu config.
  • pnpm test / pnpm test:run — execute Vitest suites; add :coverage for V8 coverage reports.

Coding Style & Naming Conventions

Stick to TypeScript ESM modules with 2-space indentation and single quotes, matching the existing files. Use camelCase for functions and variables, PascalCase for types and classes, and kebab-case for new filenames in CLI modules. Prefer named exports from feature modules and keep side effects in entry points only. ESLint (via eslint.config.ts) and lint-staged enforce formatting—run them locally before pushing.

Testing Guidelines

Vitest powers both unit and integration coverage. Place fast, isolated checks in tests/unit/*.test.ts and cross-module flows in tests/integration/. Reuse helpers from tests/helpers/ and fixtures in tests/fixtures/ to reduce duplication. When adding tests, assert CLI behavior via snapshot-safe strings and ensure pnpm test:coverage stays above existing thresholds (current reports live in coverage/).

Commit & Pull Request Guidelines

Commits follow Conventional Commits (feat:, fix:, etc.) with ≤100-character subject lines; scopes are optional but descriptive scopes (for example feat(config): ...) help reviewers. Start bodies with a blank line when explaining rationale. For pull requests, include a succinct summary, reproduction or validation steps (e.g., pnpm test output), any screenshots of CLI prompts when UX changes, and link related issues or changesets. Ensure the branch passes lint, typecheck, and tests before requesting review.

Read the full file on GitHub · 25 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. 4d ago First seen · 25 lines · 633 tokens per session scan A 8e95d6955969

Subscribe to this mod's changes

zcf AGENTS.md is an instructions file published in the GitHub repository UfoMiao/zcf (6,085 stars, last pushed 3d ago), licensed MIT. It adds 633 tokens to every session, about $0.0032 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.