What is headcleaner-cli AGENTS.md?

Repository instructions for HeadCleaner CLI, a Python tool that converts documents in a folder into Markdown or OKF files and checks the results.

They help agents install dependencies, run conversions and checks, understand the terminal interface, and follow the repository's development workflow.

They give coding agents the project's structure, commands, technology choices, and rules for making changes safely.

How jamesdsizemore/headcleaner-cli configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to jamesdsizemore/headcleaner-cli. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/jamesdsizemore/headcleaner-cli/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/jamesdsizemore/headcleaner-cli

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/jamesdsizemore/headcleaner-cli/agents-md/github.svg)](https://agentmods.dev/instructions/jamesdsizemore/headcleaner-cli/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/jamesdsizemore/headcleaner-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/jamesdsizemore/headcleaner-cli/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/jamesdsizemore/headcleaner-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/jamesdsizemore/headcleaner-cli/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,915 This file is loaded in full into every session.

When invoked 2,915 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.02915	$0.02915
Opus 5.5	$0.01166	$0.01166
Sonnet 5.5	$0.00583	$0.00583
Haiku 4.5	$0.00292	$0.00292

Measured 2mo ago against content hash 4a317a0a44fe, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

headcleaner-cli 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 2mo 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 · 219 lines

How it starts

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

AGENTS.md

This file orients AI coding agents working in this repo.

What is headcleaner?

A Python CLI that walks a folder and converts every supported document into Markdown and/or OKF v0.2 with frontmatter. Companion linter (headcleaner lint) reviews the converted output. Built with an omp-inspired TUI in a neon cyan/pink/purple palette.

The lightning-bolt jar is the brand mark.

Stack

Language: Python 3.12 (pinned in .python-version)
Package manager: uv (creates .venv/, manages deps from pyproject.toml)
TUI: Textual + custom theme.py (rounded box-drawing, powerline separators, neon palette)
Office engine: officecli binary (single binary on PATH; npm-installable: npm i -g @officecli/officecli)
Output formats: Markdown (with YAML frontmatter), OKF v0.2 (with full trust family), or both
Linter: headcleaner lint — review converted MD/OKF for formatting issues

Commands

uv sync                              # install all deps into .venv
uv run headcleaner --help            # CLI help
uv run headcleaner convert IN --output OUT  # convert a folder
uv run headcleaner lint OUT          # review converted output
unset PYTHONPATH && uv run --no-sync --python 3.13 pytest  # required test gate
uv run python -m headcleaner.cli    # same as `headcleaner`

Layout

src/headcleaner/
  __init__.py
  cli.py          # Click entrypoint (headcleaner command)
  tui.py          # Textual TUI
  theme.py        # ANSI colors + box-drawing symbols
  walk.py         # folder walker
  router.py       # ext → engine dispatch
  normalize.py    # adapter output → CanonicalDoc
  run.py          # pipeline orchestrator
  lint.py         # post-conversion linter
  engines/
    base.py       # Adapter ABC
    officecli.py  # DOCX/XLSX/PPTX
    pdf.py        # PDF (pdfplumber, opt-in pytesseract)
    html.py       # HTML/HTM (BeautifulSoup + markdownify)
    txt.py        # TXT (chardet)
  emit/
    markdown.py   # write .md with lightweight frontmatter
    okf.py        # write OKF v0.2 concept
    okf_index.py  # per-directory index.md
    manifest.py   # run-level manifest.json

tests/             # pytest suites
  conftest.py     # shared fixtures
  test_walk.py
  test_router.py
  test_normalize.py
  test_emit.py
  test_run.py
  test_lint.py
  fixtures/
    sample.xlsx   # hand-rolled valid XLSX

docs/              # active user/developer/maintainer docs plus development audits
scripts/
  verify.sh       # post-install sanity check

install.sh         # macOS / Linux / WSL one-line installer
install.ps1        # Windows PowerShell installer

Read the full file on GitHub · 219 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.

2mo ago First seen · 219 lines · 2,915 tokens per session scan A 4a317a0a44fe

Subscribe to this mod's changes

headcleaner-cli AGENTS.md is an instructions file published in the GitHub repository jamesdsizemore/headcleaner-cli (0 stars, last pushed 2mo ago), licensed Apache-2.0. It adds 2,915 tokens to every session, about $0.0117 per session on Opus 5.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-31.

Documents Languages Python

headcleaner-cli AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
headcleaner-cli AGENTS.mdjamesdsizemore/headcleaner-cli	Instructions file	0	2mo ago	Apache-2.0	A	2,915	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

headcleaner-cli: Instructions file for Codex