codachi: Instructions file for Claude Code

CLAUDE.md

codachi CLAUDE.md is an instructions file for Claude Code from vincent-k2026/codachi. It costs 1,157 tokens per session, scanned B, original, MIT.

A project instruction file for Codachi, a TypeScript terminal pet that appears in Claude Code's status line. It documents commands, project structure, and testing procedures.

In plain words
What is it for?
Use it when changing Codachi, running its tests or build, managing its plugins, or working with its command-line tools.
Why use it?
It gives the coding agent the project-specific information needed to build, test, run, configure, and uninstall Codachi correctly.

Instructions file for Claude Code

Written for Claude Code: PostToolUse hook event. Also seen: reads .claude/ paths; mentions CLAUDE.md; mentions Claude Code.

This is vincent-k2026/codachi's own configuration. It tells Claude Code how to work on codachi itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything codachi configures →

Reuse

Borrowing it

Nothing to install: this file belongs to vincent-k2026/codachi. 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/vincent-k2026/codachi/master/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/vincent-k2026/codachi

Made for: Claude Code.

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 codachi CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/vincent-k2026/codachi/claude-md/github.svg)](https://agentmods.dev/instructions/vincent-k2026/codachi/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/vincent-k2026/codachi/claude-md"><img src="https://agentmods.dev/badge/instructions/vincent-k2026/codachi/claude-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.

agentmods 80×15 button for codachi CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/vincent-k2026/codachi/claude-md"><img src="https://agentmods.dev/badge/instructions/vincent-k2026/codachi/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,157 This file is loaded in full into every session.
When invoked 1,157 The same file — it is already loaded in full.
Security scan B 1 finding. 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.01157 $0.01157
Opus 5.5 $0.00463 $0.00463
Sonnet 5.5 $0.00231 $0.00231
Haiku 4.5 $0.00116 $0.00116

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

Security

Grade B, and why

codachi CLAUDE.md scanned grade B with 1 finding 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 1mo 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.

Reads agent configuration directoriesmediumAgent snooping

.claude/, .codex/, .gemini/ hold keys, settings and other credentials a mod has no legitimate need for.

node dist/index.js init # install into ~/.claude/settings.json
CLAUDE.md · 62 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project

codachi — a tamagotchi pet that lives in the Claude Code statusline. Zero runtime dependencies, pure TypeScript compiled to ESM. Two binaries: codachi (statusline renderer, reads JSON from stdin → writes ANSI to stdout) and codachi-hook (PostToolExecution hook that records events to disk).

Commands

npm run build          # tsc → dist/ + copy locales
npm run dev            # tsc --watch
npm test               # vitest run (full suite)
npm run test:cov       # coverage
npm run bench          # render p50/p95/p99 benchmark (budget 50ms)
npx vitest run src/mood.test.ts        # single test file
npx vitest run -t "pattern"            # single test by name
node dist/index.js demo                # live terminal demo
node dist/index.js config              # interactive config TUI
node dist/index.js init                # install into ~/.claude/settings.json
node dist/index.js uninstall           # remove from settings.json
node dist/index.js stats               # local productivity dashboard
node dist/index.js plugins             # list loaded plugins

Node ≥18 required. No lint step configured; tsc is the type gate.

Architecture

Data flow — two independent processes sharing state on disk:

Claude Code ──stdin JSON──▶ index.ts (renderer, p95 ~0.1ms) ──ANSI──▶ statusline
                │
                └──PostToolUse──▶ hook.ts ──▶ events.json ──▶ mood engine on next render

The renderer never calls APIs and never blocks on I/O longer than a git status (cached 2s). The hook's only job is to classify a tool-use event and append it; it must stay fast and cannot assume the renderer is running. Events use an optimistic-concurrency generation counter to prevent lost updates from concurrent hooks.

State lives in ~/.claude/plugins/codachi/ (session state, events, memory, error log) and ~/.config/codachi/config.json (user config). All writes are atomic (write-tmp + rename) via fs-utils.ts. Pet identity is bound to transcript_path so each Claude session gets a stable species/palette.

Read the full file on GitHub · 62 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. 1mo ago First seen · 62 lines · 1,157 tokens per session scan B 0922f7907d7a

Subscribe to this mod's changes

codachi CLAUDE.md is an instructions file published in the GitHub repository vincent-k2026/codachi (14 stars, last pushed 6mo ago), licensed MIT. It adds 1,157 tokens to every session, about $0.0046 per session on Opus 5.5. A static security scan graded it B with 1 finding (reads agent configuration directories). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens