What is obsidian CLAUDE.md?

A set of project instructions for Claude Code on WebObsidian, a self-hosted web app for managing Obsidian notes. It explains the project context, required documents, and development rules.

Use it when adding features, changing the design, updating project progress, or checking the technical conventions of WebObsidian.

It keeps coding work aligned with the product requirements and implementation plan instead of relying on undocumented decisions.

How tuongzaza/obsidian configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to tuongzaza/obsidian. 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/tuongzaza/obsidian/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/tuongzaza/obsidian

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/tuongzaza/obsidian/claude-md/github.svg)](https://agentmods.dev/instructions/tuongzaza/obsidian/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/tuongzaza/obsidian/claude-md"><img src="https://agentmods.dev/badge/instructions/tuongzaza/obsidian/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/tuongzaza/obsidian/claude-md"><img src="https://agentmods.dev/badge/instructions/tuongzaza/obsidian/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 612 This file is loaded in full into every session.

When invoked 612 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 100% copy Near-identical to another mod 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.

Model	Per session	Once invoked
Fable 5.1	$0.00612	$0.00612
Opus 5	$0.00306	$0.00306
Sonnet 5	$0.00122	$0.00122
Haiku 4.5	$0.00061	$0.00061

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

Security

Grade A, and why

obsidian 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 9d 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.

Origin

This is a copy

100% identical to webobsidian CLAUDE.md — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

CLAUDE.md · 44 lines

How it starts

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

CLAUDE.md — Hướng dẫn làm việc cho Claude Code trên dự án WebObsidian

Bối cảnh

WebObsidian là web app self-hosted clone toàn diện Obsidian. Thiết kế chính thức nằm ở PRD.md. Tiến độ phát triển được track ở IMPLEMENTATION_PLAN.md.

Nguyên tắc bắt buộc (đọc trước mỗi phiên làm việc)

Luôn bám sát PRD.md. Trước khi code một tính năng, đối chiếu với phần FR/NFR/API/data model tương ứng trong PRD. Không tự ý đổi kiến trúc hay phạm vi. Nếu thấy cần lệch khỏi PRD, cập nhật PRD.md trước (ghi rõ lý do, tăng version/changelog) rồi mới code.
Luôn cập nhật IMPLEMENTATION_PLAN.md. Mỗi khi bắt đầu hoặc hoàn thành một mục:
- Đổi checkbox: [ ] → [~] (đang làm) → [x] (xong).
- Cập nhật dòng "Cập nhật lần cuối" và thêm dòng vào "Nhật ký tiến độ" (ngày + tóm tắt).
- Một mục chỉ đánh [x] khi code chạy được/được kiểm chứng, không phải khi mới viết xong.
Đồng bộ với todo list của session. Todo nội bộ phải phản ánh các mục trong plan.
Tài liệu là nguồn sự thật. Khi phạm vi thay đổi theo yêu cầu người dùng: cập nhật PRD.md (thiết kế) và IMPLEMENTATION_PLAN.md (thêm/sửa mục) trong cùng lần thay đổi.

Quy ước kỹ thuật

Ngôn ngữ: TypeScript cho cả server và web. Tránh any khi có thể.
Cấu hình runtime: chỉ dùng file JSON (data/settings.json) — không thêm DB engine.
Bảo mật: không log secret/token/API key; hash trước khi lưu; guard path traversal.
Commit/push git chỉ khi người dùng yêu cầu.

Lệnh hữu ích

npm install            # cài deps toàn workspace
npm run dev            # chạy server + web (dev)
npm run build          # build web rồi server
npm run start          # chạy production (server serve web đã build)
npm run typecheck      # kiểm tra type cả 2 workspace
docker compose up      # chạy full stack

Cấu trúc (xem PRD §2.2)

server/ — Express API (routes, services, middleware, plugins shim).
web/ — React SPA (components, lib, styles).
data/ — runtime config & index (gitignored).
docs/ — tài liệu bổ sung.

Read the full file on GitHub · 44 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.

9d ago First seen · 44 lines · 612 tokens per session scan A d052998650ce

Subscribe to this mod's changes

obsidian CLAUDE.md is an instructions file published in the GitHub repository tuongzaza/obsidian (83 stars, last pushed 27d ago), licensed MIT. It adds 612 tokens to every session, about $0.0031 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to webobsidian CLAUDE.md, differing in 0 lines, and is treated as a copy.

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

obsidian: Instructions file for Claude Code