What is workbuddian CLAUDE.md?

A desktop-only Obsidian plugin that embeds the local WorkBuddy or CodeBuddy command-line agent inside an Obsidian vault. Obsidian is a note-taking app that stores linked notes as files.

Use it to develop, build, test, or distribute the Workbuddian plugin and its bundled JavaScript file.

It tells developers which operating systems and Obsidian version are supported, how the plugin is built, and how its tests run.

How jiang198012/workbuddian configures Claude Code

Reuse

Borrowing it

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

Clone the repo

git clone --depth 1 https://github.com/jiang198012/workbuddian

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/jiang198012/workbuddian/claude-md/github.svg)](https://agentmods.dev/instructions/jiang198012/workbuddian/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/jiang198012/workbuddian/claude-md"><img src="https://agentmods.dev/badge/instructions/jiang198012/workbuddian/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/jiang198012/workbuddian/claude-md"><img src="https://agentmods.dev/badge/instructions/jiang198012/workbuddian/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,005 This file is loaded in full into every session.

When invoked 2,005 The same file — it is already loaded in full.

Security scan A 1 finding. 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.

Model	Per session	Once invoked
Fable 5.1	$0.02005	$0.02005
Opus 5.5	$0.00802	$0.00802
Sonnet 5.5	$0.00401	$0.00401
Haiku 4.5	$0.00200	$0.00200

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

Security

Grade A, and why

workbuddian CLAUDE.md scanned grade A with 1 finding 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.

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

- `tests/acpClient.test.ts` mocks `child_process` (`jest.mock('child_process')`) to drive the ACP transport without a real CLI; `tests/api.test.ts` / `tests/providerCallbacks.test.ts` instead mock `providers/codebuddy/ac

CLAUDE.md · 57 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this is

Workbuddian is a desktop-only Obsidian community plugin (isDesktopOnly: true, Obsidian ≥ 1.7.2) that embeds the local WorkBuddy / CodeBuddy CLI as an AI chat agent inside a vault. Its UI references Claudian (MIT). Windows + macOS only; Linux is unsupported. Logs are prefixed [WB].

Commands

npm install            # required first — node_modules is not checked in
npm run dev            # esbuild watch build (rebuilds main.js on save)
npm run build          # tsc -noEmit typecheck THEN esbuild production bundle
npm test               # jest --coverage
npm run test:watch     # jest watch mode
npx jest tests/manager.test.ts     # run a single test file
npx jest -t "substring of test name"   # run tests matching a name

npm run build runs tsc -noEmit -skipLibCheck purely as a typecheck gate — the actual bundle is produced by esbuild, not tsc. There is no separate lint step.

Build & distribution model

Entry point src/main.ts (default export WorkbuddianPlugin) is bundled by esbuild.config.mjs into a single main.js at the repo root. obsidian, electron, CodeMirror packages, and Node builtins are marked external.
main.js is committed — .gitignore ignores all *.js but re-includes !main.js. The distributable plugin is the three files main.js + manifest.json + styles.css. When you change source, the committed main.js is only correct after a build.
Two versions coexist and can drift: package.json (1.0.13, npm/dev) vs manifest.json (0.1.0, the Obsidian-facing plugin version). version-bump.mjs (via npm version) syncs manifest.json + versions.json.

Architecture

Layered, single-responsibility modules under src/. The flow of a message: features/chat/input.ts → core/context/assembleContext.ts → providers/codebuddy (ACP persistent process) → streams StreamChunks back into the DOM and into core/session/manager.ts for persistence.

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

2mo ago First seen · 57 lines · 2,005 tokens per session scan A 9a6d030536ea

Subscribe to this mod's changes

workbuddian CLAUDE.md is an instructions file published in the GitHub repository jiang198012/workbuddian (69 stars, last pushed 8d ago), licensed MIT. It adds 2,005 tokens to every session, about $0.0080 per session on Opus 5.5. A static security scan graded it A with 1 finding (runs shell commands). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

LLM agent ai ai-chat codebuddy obsidian

workbuddian CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
workbuddian CLAUDE.mdjiang198012/workbuddian	Instructions file	69	8d ago	MIT	A	2,005	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

workbuddian: Instructions file for Claude Code