codework AGENTS.md

A project instruction file that tells a coding agent which languages, tools, commands, and coding preferences to follow.

In plain words
What is it for?
It guides TypeScript development, package-manager choice, code style, checks, and decisions about preferred technologies.
Why use it?
It keeps the agent's work aligned with the project's conventions and avoids unsuitable commands or package managers.

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

Made for: Codex, OpenCode.

Per session 1,006 This file is loaded in full into every session.
When invoked 1,006 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.01006 $0.01006
Opus 5 $0.00503 $0.00503
Sonnet 5 $0.00201 $0.00201
Haiku 4.5 $0.00101 $0.00101

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

Security

Grade A, and why

codework 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 yesterday.

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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

AGENTS.md · 82 lines

How it starts

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

Personal Preference

TypeScript

  • Never use any unless 100% necessary or specifically instructed.
  • Use effect only if the project uses effect or specifically instructed, use effect reference repository for latest architecture patterns.

Commands

  • Don't run dev server commands (e.g pnpm run dev) - assume it's already running.
  • Don't run build commands unless specifically told to.
  • Focus on checking commands like pnpm run typecheck, pnpm run check, bun run lint, etc

Package Managers

  • Use pnpm, vp - vite plus if the project already uses it, otherwise use pnpm
  • Never use npm or `yarn

Tech Stack Preference

When uncertain, prefer: Effect, Tailwind, TypeScript, React, Clerk, TanStack, Vercel, Vite

Code Style

  • Always strive for concise, simple solutions.
  • If a problem can be solved in a simpler way, propose it.
  • No pre-mature optimizations, propose if required.
  • Use single word filename whenever possible otherwise split into kabab-case(only if no options).

General Preferences

  • If asked to do too much work at once, stop and state that clearly.
  • If computer use is helpful for completing or verifying work, use it.
  • Avoid defensive future-facing design. This leads to pre-mature assumptions which are never true.

Maintainability

Long term maintainability is a core priority. If you add new functionality, first check if there is shared logic that can be extracted to a separate module. Duplicate logic across multiple files is a code smell and should be avoided. Don't be afraid to change existing code. Don't take shortcuts by just adding local logic to solve a problem.

Package Roles

  • packages/aikit - Low level SDK that provides unified LLM API for multiple LLM providers.
  • packages/harness - Effect powered main Agent Harness application, uses packages/aikit under the hood.
  • packages/utils - Shared support utilities used by packages/aikit and packages/harness.
  • .scratch/packages - Local, ignored reference archive for packages that are no longer developed.

Read the full file on GitHub · 82 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. yesterday First seen · 82 lines · 1,006 tokens per session scan A a3b9934cf5c7

Subscribe to this mod's changes

codework AGENTS.md is an instructions file published in the GitHub repository codeworksh/codework (23 stars, last pushed 4d ago), licensed MIT. It adds 1,006 tokens to every session, about $0.0050 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.