yorkie-js-sdk: Instructions file for Claude Code

CLAUDE.md

yorkie-js-sdk CLAUDE.md is an instructions file for Claude Code from yorkie-team/yorkie-js-sdk. It costs 1,015 tokens per session, scanned A, original, Apache-2.0.

Development instructions for Yorkie JavaScript SDK, a pnpm monorepo containing several packages for collaborative editing applications. A monorepo is one repository that holds multiple related packages.

In plain words
What is it for?
Use it to build, lint, test, or update the SDK and its related packages, including React, schema, ProseMirror, and developer-tools packages.
Why use it?
They provide the project’s required setup and checks, including the Yorkie server needed for tests. This reduces failures caused by using the wrong package commands or testing without the required service.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: reads .claude/ paths; mentions Claude Code.

This is yorkie-team/yorkie-js-sdk's own configuration. It tells Claude Code how to work on yorkie-js-sdk 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 yorkie-js-sdk configures →

Reuse

Borrowing it

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

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 yorkie-js-sdk CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/yorkie-team/yorkie-js-sdk/claude-md"><img src="https://agentmods.dev/badge/instructions/yorkie-team/yorkie-js-sdk/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,015 This file is loaded in full into every session.
When invoked 1,015 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.01015 $0.01015
Opus 5.5 $0.00406 $0.00406
Sonnet 5.5 $0.00203 $0.00203
Haiku 4.5 $0.00102 $0.00102

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

Security

Grade A, and why

yorkie-js-sdk 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 20d 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 · 74 lines

How it starts

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

Yorkie JavaScript SDK

pnpm monorepo with multiple packages for building collaborative editing applications.

Development Commands

pnpm i                       # Install (pnpm enforced)
pnpm sdk build               # Build core SDK
pnpm sdk build:proto         # Regenerate protobuf code (buf generate)
pnpm lint                    # ESLint with auto-fix (zero warnings enforced)

# Tests require a running Yorkie server:
docker compose -f docker/docker-compose.yml up --build -d
pnpm sdk test                # Run all SDK tests (waits for the server first)
pnpm sdk test test/integration/tree_test.ts  # Specific test file

Package filters: pnpm sdk, pnpm react, pnpm schema, pnpm prosemirror, pnpm devtools

After Making Changes

Always run before submitting:

pnpm verify:fast   # lint, licence headers, doc links, build, unit tests (~30s, no server)
pnpm sdk test      # plus the integration suites, with the server above running

Task Workflow

  1. Plan — write docs/tasks/active/YYYYMMDD-<slug>-todo.md before code; update docs/design/ if architecture changes.
  2. Branch + commit — topic branch from main; each commit pnpm verify:fast green. bash scripts/setup.sh installs hooks that check this for you — lint-staged on commit, verify:fast on push.
  3. Self review — /self-review: review → fix → re-verify over the full branch diff, max 3 rounds, stopping at the first round with no blocking findings. Log each round in *-lessons.md; a finding you believe is wrong goes there with evidence.
  4. Open PR — rebase onto the base first (origin/main, or upstream/main from a fork). Body = Summary + Test plan.
  5. Before merge — bash scripts/tasks-archive.sh && bash scripts/tasks-index.sh, and turn anything left under "Out of scope" / "Open" in the todo into an issue. node scripts/tasks-check.mjs --base origin/main --remote (CI runs it on every PR) warns when a finished task is still in active/.

Read the full file on GitHub · 74 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. 20d ago Changed · +20 tokens per session 25c84e5e584b
  2. 24d ago Changed · +3 lines · +60 tokens per session 044252fef255
  3. 28d ago Changed · +7 tokens per session a4eafc95eecd
  4. 1mo ago Changed · +17 lines · +335 tokens per session e823dd80d2f2
  5. 2mo ago First seen · 54 lines · 593 tokens per session scan A 34d27af6f4d0

Subscribe to this mod's changes

yorkie-js-sdk CLAUDE.md is an instructions file published in the GitHub repository yorkie-team/yorkie-js-sdk (163 stars, last pushed yesterday), licensed Apache-2.0. It adds 1,015 tokens to every session, about $0.0041 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-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,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