obsidian-gate: Instructions file for Claude Code

CLAUDE.md

obsidian-gate CLAUDE.md is an instructions file for Claude Code from rileygramlich/obsidian-gate. It costs 388 tokens per session, scanned A, original, MIT.

A project instruction file for Claude Code, covering how to build, test, and publish the Obsidian Gate package to npm, a package registry for JavaScript software.

In plain words
What is it for?
Use it when working on Obsidian Gate and preparing a new npm release.
Why use it?
It gives the coding agent the project’s release steps, including checking that the build and tests pass before publishing.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md.

This is rileygramlich/obsidian-gate's own configuration. It tells Claude Code how to work on obsidian-gate 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 obsidian-gate configures →

Reuse

Borrowing it

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

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 obsidian-gate CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/rileygramlich/obsidian-gate/claude-md.svg)](https://agentmods.dev/instructions/rileygramlich/obsidian-gate/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/rileygramlich/obsidian-gate/claude-md"><img src="https://agentmods.dev/badge/instructions/rileygramlich/obsidian-gate/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 388 This file is loaded in full into every session.
When invoked 388 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.1 $0.00388 $0.00388
Opus 5 $0.00194 $0.00194
Sonnet 5 $0.00078 $0.00078
Haiku 4.5 $0.00039 $0.00039

Measured 2d ago against content hash 8176b4af0fc2, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

obsidian-gate 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 2d 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 · 40 lines

What it actually says

Vault Gate

An Obsidian community plugin that runs an MCP server inside Obsidian. The repo root is the plugin (Obsidian's store requires manifest.json there); server/ holds the older standalone Node CLI, which is independent.

Build

npm install
npm run dev     # watch → main.js
npm run build   # tsc --noEmit + production bundle
npm test        # bundles test/entry.ts, then node --test

Before releasing

  1. npm version <patch|minor|major> — updates manifest.json and versions.json
  2. git push --follow-tags — the release workflow builds and attaches main.js, manifest.json, styles.css
  3. Obsidian's store reads the manifest from the repo root and the assets from the release, so both must carry the same version

Conventions

  • No new runtime dependencies. main.js bundles everything except Node builtins and obsidian; the MCP protocol is implemented directly rather than via the SDK to keep the bundle small and reviewable.
  • Build DOM with createEl/createSpan/setText. Never innerHTML — the community-plugin review rejects it.
  • Style with Obsidian's CSS variables in styles.css, not inline styles.
  • src/vault.ts is the only file that may import from obsidian for runtime values besides the UI files; everything else stays testable in plain Node.

The standalone CLI

server/ is the pre-plugin product: a Node MCP server that reads a vault off disk, with a dashboard and Stripe licensing. It is not built or shipped with the plugin. Its own npm test runs from inside that directory.

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. 2d ago Changed · +15 lines · +305 tokens per session 8176b4af0fc2
  2. 5d ago First seen · 25 lines · 83 tokens per session scan A 085a98d3f0bd

Subscribe to this mod's changes

obsidian-gate CLAUDE.md is an instructions file published in the GitHub repository rileygramlich/obsidian-gate (0 stars, last pushed 2d ago), licensed MIT. It adds 388 tokens to every session, about $0.0019 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-31.

Related

Other instructions, from other repositories

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,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

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 · 6,785 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 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,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens