zeichenwerk AGENTS.md

A set of project instructions for Zeichenwerk, a Go framework, covering coding style, documentation, libraries, and the order new contributors should read its materials.

In plain words
What is it for?
Use it when changing Zeichenwerk code or documentation, especially when following its error handling, logging, dependency, file-format, and contributor-guidance rules.
Why use it?
It gives contributors clear rules for writing consistent Go code and understanding the framework's existing design decisions.

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

Made for: Codex, OpenCode.

Per session 7,156 This file is loaded in full into every session.
When invoked 7,156 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.07156 $0.07156
Opus 5 $0.03578 $0.03578
Sonnet 5 $0.01431 $0.01431
Haiku 4.5 $0.00716 $0.00716

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

Security

Grade A, and why

zeichenwerk 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 · 387 lines

How it starts

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

Guidelines

Normative Keywords

  • MUST: mandatory requirement
  • SHOULD: recommended but optional with justification
  • MAY: optional

Core Principles

  • MUST follow idiomatic Go patterns
  • MUST minimize dependencies
  • MUST use explicit error handling
  • SHOULD keep functions <= 50 lines
  • SHOULD prefer composition over inheritance patterns

File Formats

  • MUST use Markdown for documentation files

Libraries

  • MUST use log/slog for logging

Reading order for new contributors

Extracted apps

Most cmd/ tools were extracted to standalone repos under tekugo/. Each consumes zeichenwerk as a normal dependency, so app-only deps don't leak into the library's go.mod:

What stays in cmd/: showcase apps (demo, demo2, compose, showcase, editor), dev tools (zw, analyzer, coverage), and proof-of-concept drivers (designer-poc, inspector-poc).

Read the full file on GitHub · 387 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 · 387 lines · 7,156 tokens per session scan A 56a85e5ea60c

Subscribe to this mod's changes

zeichenwerk AGENTS.md is an instructions file published in the GitHub repository tekugo/zeichenwerk (85 stars, last pushed 1mo ago), licensed MIT. It adds 7,156 tokens to every session, about $0.0358 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.