planning-with-files AGENTS.md

planning-with-files AGENTS.md is an instructions file for Codex, OpenCode from OthmanAdi/planning-with-files. It costs 2,236 tokens per session, scanned A, original, MIT.

A project instruction file that tells coding agents how to handle commits, releases, version changes, changelog entries, and issue or pull-request communication.

In plain words
What is it for?
It helps agents prepare releases, update versions and changelogs, review issues and pull requests, and follow the repository’s commit and publishing rules.
Why use it?
It gives every agent the same repository rules, reducing mistakes such as lost contributor credit, incorrect commit formats, or skipped release checks.

Instructions file for CodexOpenCode

About the project

OthmanAdi/planning-with-files is a planning system that stores an AI coding agent's task plan, findings, and progress in project files so the work can be recovered after context resets, crashes, or compaction. It is for long-running coding tasks across many agent tools, including Claude Code, Codex CLI, and Cursor. The catalogue entries are the project's commands, hooks, skills, plugin, and instruction for maintaining those planning files.

OthmanAdi/planning-with-files · 26,631 stars · on GitHub

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/othmanadi/planning-with-files/agents-md
Clone the repo
git clone --depth 1 https://github.com/OthmanAdi/planning-with-files

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 planning-with-files AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/othmanadi/planning-with-files/agents-md.svg)](https://agentmods.dev/instructions/othmanadi/planning-with-files/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/othmanadi/planning-with-files/agents-md"><img src="https://agentmods.dev/badge/instructions/othmanadi/planning-with-files/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,236 This file is loaded in full into every session.
When invoked 2,236 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.02236 $0.02236
Opus 5 $0.01118 $0.01118
Sonnet 5 $0.00447 $0.00447
Haiku 4.5 $0.00224 $0.00224

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

Security

Grade A, and why

planning-with-files 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 · 162 lines

How it starts

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

AGENTS.md — planning-with-files agent reference card

This file is the canonical, session-portable reference for how every agent working in this repo must handle commits, releases, version bumps, CHANGELOG entries, and issue/PR communication.


Commit rules

  • Author: OthmanAdi only for release/maintenance commits. NEVER add Co-Authored-By: trailers.
  • Format: Conventional Commits — fix:, feat:, release:, docs: prefixes.
  • One release commit on top of the contributor commit(s), never a squash of the contributor's work. git merge --squash rewrites the committer as whoever runs the local commit, which reassigns the contributor's authorship to OthmanAdi — this happened once (v2.40.1 cycle) and is exactly what this rule exists to prevent. Squashing is fine only for collapsing your OWN WIP commits before pushing.
  • No --no-verify. No force push to master except tag ref updates.
  • Contributors are credited in CHANGELOG ### Thanks and CONTRIBUTORS.md, never in commit trailers.

Release checklist (12 steps)

  1. gh issue view N and gh pr view N — read both in full.
  2. Verify the bug is real: find the exact file/line, grep for the pattern, confirm reporter is correct.
  3. python -m pytest tests/ -q — all tests pass before touching anything.
  4. Merge preserving contributor authorship: git fetch origin pull/N/head:pr-N && git cherry-pick <pr-head-sha>, or gh pr merge --rebase. Do NOT use git merge --squash — it collapses the contributor's commit and reassigns the Author: field to whoever runs the local commit, destroying their credit in git log.
  5. CHANGELOG — new version entry at top, ### Fixed/### Added/### Changed, sachlich, no em-dashes.
  6. CONTRIBUTORS.md — add reporter/contributor, bump "Total Contributors: N+", update "Last updated" date.
  7. Version bump across all 19 tracked targets plus the local ClawHub staging target when present (see table below). Then run python scripts/build-clawhub-upload.py and python scripts/build-clawhub-upload.py --verify; verification must report that the complete staging folder matches the canonical tracked inventory.
  8. README — update version badge and add row to releases table.
  9. git commit, git tag vX.Y.Z, git push origin master, git push origin vX.Y.Z.
  10. gh release create vX.Y.Z --title "vX.Y.Z - <short description>" --notes "<release notes>".
  11. Post comment on PR and/or issue via gh issue comment N --body "..." (run through /humanizer first).
  12. gh issue close N if applicable.

Read the full file on GitHub · 162 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 Changed · +42 tokens per session c6aeaa9d7fec
  2. 5d ago First seen · 162 lines · 2,194 tokens per session scan A cae4bfdd4e06

Subscribe to this mod's changes

planning-with-files AGENTS.md is an instructions file published in the GitHub repository OthmanAdi/planning-with-files (26,631 stars, last pushed 2d ago), licensed MIT. It adds 2,236 tokens to every session, about $0.0112 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.