tiptap AGENTS.md

Repository instructions for Tiptap, a rich-text editor toolkit built from small packages and framework integrations. They describe code style, testing, releases, and pull requests.

In plain words
What is it for?
Use them when changing Tiptap packages, demos, tests, public APIs, or documentation. They also specify commands to run before opening a pull request.
Why use it?
They give coding agents the project’s rules and checks, reducing inconsistent changes and missed tests or release notes.

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

Made for: Codex, OpenCode.

Per session 1,531 This file is loaded in full into every session.
When invoked 1,531 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.01531 $0.01531
Opus 5 $0.00766 $0.00766
Sonnet 5 $0.00306 $0.00306
Haiku 4.5 $0.00153 $0.00153

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

Security

Grade A, and why

tiptap 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.

AGENTS.md · 157 lines

How it starts

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

Tiptap

Headless rich text editor toolkit built on ProseMirror. A monorepo of small packages: a framework-agnostic core and extensions, plus React and Vue bindings.

Published packages live in packages/*. demos/ is a Vite app used as playground and as the target for e2e tests. All scripts are in the root package.json.

Rules

  • Small, single-purpose diffs. Ask the user to review. Never autocommit.
  • Add a changeset for user-facing changes. Public API breaks need a major bump and migration notes.
  • Add or update a demo and tests for user-visible behavior. Prefer unit tests over e2e when deterministic.
  • Fix fallow findings your change introduced. Don't suppress them.
  • Comments should be clear, concise and use plain, simple english.
    • Rather use a oneliner
    • Try to always be intent-focused
    • stay local with comments
    • scannable, no long or complex wording
    • assume the reader doesn't know what you're talking about

Before opening a PR

vp run lint
vp run build
vp run test:unit
vp run test:e2e
vp run fallow:audit   # verdict must be pass or warn, never fail

Single package failing types: vp run -F @tiptap/core build. Dependency or lockfile errors: vp run reset, then rebuild.

Code style

oxlint lints, oxfmt formats. Vite+ hooks (vp staged) run both on commit.

Prefer simple, readable code over clever code. Use early returns. Avoid deep nesting, nested ternaries, and abstractions you don't need yet. Keep functions focused. Apply DRY and SOLID pragmatically, not blindly.

Files

  • Keep files small and focused. Split unrelated utilities, types, constants and logic apart.
  • One reusable utility per file, named after its export: findDecorations.ts, addDecoration.ts. Not utils.ts, helpers.ts, decorations.ts.
  • A helper used in one file only can stay local.

Naming

  • Short, clear, recognizable. Never shorten just to save characters. No unclear abbreviations.
  • index for numeric indexes, the item's real name for collection values. Single letters only in small math contexts like x and y.
  • Use existing project terminology.

Read the full file on GitHub · 157 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 · 157 lines · 1,531 tokens per session scan A 476252997808

Subscribe to this mod's changes

tiptap AGENTS.md is an instructions file published in the GitHub repository ueberdosis/tiptap (38,197 stars, last pushed 3d ago), licensed MIT. It adds 1,531 tokens to every session, about $0.0077 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.