outl: Instructions file for Claude Code

CLAUDE.md

outl CLAUDE.md is an instructions file for Claude Code from outlmd/outl. It costs 12,336 tokens per session, scanned A, original, MIT.

Repository instructions for outl, a local-first outliner that stores notes as Markdown and synchronises changes between devices. An outliner is a tool for organising nested notes and lists; a CRDT is a data structure designed to merge concurrent changes.

In plain words
What is it for?
Read it before changing outl’s storage, synchronisation, Markdown projection, terminal interface, or repository structure.
Why use it?
It explains the project’s non-negotiable data rules, helping contributors avoid corrupting the operation log, Markdown files, or synchronisation state.

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 outlmd/outl's own configuration. It tells Claude Code how to work on outl 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 outl configures →

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/outlmd/outl/claude-md"><img src="https://agentmods.dev/badge/instructions/outlmd/outl/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 12,336 This file is loaded in full into every session.
When invoked 12,336 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.12336 $0.12336
Opus 5.5 $0.04934 $0.04934
Sonnet 5.5 $0.02467 $0.02467
Haiku 4.5 $0.01234 $0.01234

Measured 6d ago against content hash 7e9b09f458ed, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

outl CLAUDE.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 6d 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.

CLAUDE.md · 530 lines

How it starts

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

CLAUDE.md — outl

Context for Claude Code sessions working on this repo. Read this before making any change.

What this project is

outl is a local-first outliner (Roam/Logseq replacement) with:

  • Markdown as source of truth — .md files are 100% clean, no visible IDs.
  • Conflict-free sync via a tree CRDT (Kleppmann et al. 2022).
  • Trait-based storage — JSONL (one file per actor) is the only persistent backend; ChronDB on the roadmap.
  • TUI as a first-class citizen, not an afterthought.
  • Journal-first — daily notes are the primary entry point.

Full spec lives in the README and docs/. Don't skim — read.

Critical invariants (NEVER violate)

These are the non-negotiables. Violating any one breaks user trust irreversibly.

  1. Op log is source of truth. All mutations go through Op → apply_op → log. The materialized tree and .md files are projections. Never edit .md to "fix" state.

  2. Markdown stays 100% clean. No id::, no UUID inline, no HTML comments, nothing. IDs live ONLY in the .outl sidecar (JSON file next to the .md, e.g. pages/foo.outl). The sidecar is not a dotfile, because iCloud Documents (when used as the file transport) drops dotted paths during cross-device sync and silently breaks multi-device workspaces. Same rule applies to ops/.

  3. CRDT follows Kleppmann 2022 literally. do_op / undo_op / apply_op / creates_cycle must match the paper. 100% coverage on these four is non-negotiable.

  4. Move that creates a cycle is a no-op on the materialized tree, but the op still goes into the log. Removing it breaks correctness of future reordering.

  5. Storage is a trait, not a struct. JsonlStorage is the only persistent impl, and tests use MemoryStorage. Anything that wants to persist ops goes through dyn Storage. No second persistent backend lands without an issue + RFC first, because divergence between storages is exactly what we paid to remove in 0.5.0.

Read the full file on GitHub · 530 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. 6d ago Changed · +5 lines · +307 tokens per session 7e9b09f458ed
  2. 9d ago Changed · +1 lines · +29 tokens per session 8fbc53af8ab0
  3. 14d ago Changed · +3 lines · +93 tokens per session ef53879b9282
  4. 23d ago Changed · +15 lines · +693 tokens per session 03b25923f41c
  5. 29d ago Changed · +6 lines · +157 tokens per session 7e3620c85101
  6. 1mo ago Changed · +45 lines · +1,171 tokens per session 6bc6af718ec7
  7. 1mo ago Changed · +3 lines · +80 tokens per session 1c19e3382818
  8. 1mo ago Changed · -2 lines · +20 tokens per session e136d2287b1a
  9. 1mo ago Changed · +13 lines · +528 tokens per session 78264340818f
  10. 1mo ago First seen · 441 lines · 9,258 tokens per session scan A 687ca1d24e7e

Subscribe to this mod's changes

outl CLAUDE.md is an instructions file published in the GitHub repository outlmd/outl (222 stars, last pushed yesterday), licensed MIT. It adds 12,336 tokens to every session, about $0.0493 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-09-01.

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,750 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