ownly: Instructions file for Claude Code

CLAUDE.md

ownly CLAUDE.md is an instructions file for Claude Code from liuh886/ownly. It costs 770 tokens per session, scanned A, original, MIT.

Project-specific instructions for developing the Ownly Obsidian plugin. Obsidian is a note-taking application that can be extended with plugins.

In plain words
What is it for?
Use them when changing Ownly, building its JavaScript, CSS, or manifest files, copying updates into the Obsidian vault, and synchronising changes with the remote repository.
Why use it?
They clarify which folders contain the source and running files, and describe the required build, synchronisation, commit, and push workflow.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions AGENTS.md; mentions Codex.

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

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/liuh886/ownly/claude-md"><img src="https://agentmods.dev/badge/instructions/liuh886/ownly/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 770 This file is loaded in full into every session.
When invoked 770 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.00770 $0.00770
Opus 5.5 $0.00308 $0.00308
Sonnet 5.5 $0.00154 $0.00154
Haiku 4.5 $0.00077 $0.00077

Measured 2mo ago against content hash cfd11b06a5cf, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

ownly 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 2mo 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 · 70 lines

What it actually says

@AGENTS.md


Ownly 项目开发必读 (Developer Workflow)

架构概览与多端运行时

Ownly 是一个 Local-First 的所有物决策与旅行规划系统,由 5 个核心运行时组成:

  1. Web App / PWA (src/app/, src/components/) — 基于 Next.js Turbopack 构建的独立 Web 决策台与行程规划工作台。
  2. Obsidian Plugin (src/obsidian/) — 嵌入 Obsidian 的原生插件视图。
  3. Capture Chrome Extension (src/extension/, extension/) — MV3 Chromium 侧边栏与 6 大平台页面采集器。
  4. Local MCP Server (packages/mcp/) — 面向 Claude / Codex / 智能体系统的两阶段确认事实接口。
  5. Agent CLI (scripts/cli/) — 确定性本地 Markdown 操作终端工具。

路径别名

别名 路径 说明
@repo D:\Documents\GitHub\Ownly 源码仓库主目录
@vault D:\Documents\zhihaol 本地 Obsidian 测试 Vault
@plugin D:\Documents\zhihaol\.obsidian\plugins\ownly Obsidian 插件运行时目录

开发与验证门禁 (Quality Gates)

在提交任何代码前,必须执行并通过以下对应校验门禁:

# 1. 快速静态检查 (TypeScript + ESLint + Terminology + Membership)
npm run validate:fast

# 2. Chrome Extension 校验 (Manifest + Build + 单元测试)
npm run validate:extension

# 3. 共享契约与运行时对齐测试 (MCP + CLI + Planner + Parity)
npm run validate:shared

# 4. Next.js 生产环境构建校验
npm run build

Obsidian 插件同步规则

当开发涉及 Obsidian 插件相关代码(src/obsidian/)时,构建后需同步产物至本地测试 Vault:

# 构建 Obsidian 插件产物
npm run build:obsidian

# 同步至本地测试 Vault
cp main.js /path/to/vault/.obsidian/plugins/ownly/main.js
cp styles.css /path/to/vault/.obsidian/plugins/ownly/styles.css
cp manifest.json /path/to/vault/.obsidian/plugins/ownly/manifest.json

Git 提交与推送规则 (P0)

每次集中完成功能开发或缺陷修复后:

  1. git add 相关变更文件(避免夹带无关临时文件)
  2. git commit -m "feat/fix/chore: <清晰描述>"
  3. git push origin <branch> 保持远程同步

标准开发流程 (Checklist)

  1. ✅ 编写/修改源码 (src/)
  2. ✅ 执行对应自动化测试与验证门禁 (npm run validate:fast 等)
  3. ✅ 必要时构建多端产物 (npm run build, npm run build:extension)
  4. ✅ 更新文档与 tasks/todo.md
  5. ✅ Git commit + push
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. 2mo ago Changed · +7 lines · +135 tokens per session cfd11b06a5cf
  2. 2mo ago First seen · 63 lines · 635 tokens per session scan A 97e145145b78

Subscribe to this mod's changes

ownly CLAUDE.md is an instructions file published in the GitHub repository liuh886/ownly (3 stars, last pushed 15d ago), licensed MIT. It adds 770 tokens to every session, about $0.0031 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-31.

Related

ownly CLAUDE.md compared with instructions from other repositories

ownly CLAUDE.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
ownly CLAUDE.mdliuh886/ownlyInstructions file315d agoMITA770Claude Code
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,649GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
vscode ai-customization.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA1,907GitHub Copilot