obsidian-vfs AGENTS.md

obsidian-vfs AGENTS.md is an instructions file for Codex, OpenCode from otaviof/obsidian-vfs. It costs 854 tokens per session, scanned A, original, Apache-2.0.

Project instructions for obsidian-vfs, a tool that shares Obsidian notes between VSCode and Claude Code through a virtual file system.

In plain words
What is it for?
Building and checking the project, editing shared core logic, maintaining the VSCode or Claude plugin packages, and updating versions consistently.
Why use it?
They describe the project boundaries, build rules, formatting requirement, bundled hook, and version files so changes do not break one of its separate packages.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/otaviof/obsidian-vfs/agents-md
Clone the repo
git clone --depth 1 https://github.com/otaviof/obsidian-vfs

Made for: Codex, OpenCode.

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-vfs AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/otaviof/obsidian-vfs/agents-md.svg)](https://agentmods.dev/instructions/otaviof/obsidian-vfs/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/otaviof/obsidian-vfs/agents-md"><img src="https://agentmods.dev/badge/instructions/otaviof/obsidian-vfs/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 854 This file is loaded in full into every session.
When invoked 854 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.00854 $0.00854
Opus 5 $0.00427 $0.00427
Sonnet 5 $0.00171 $0.00171
Haiku 4.5 $0.00085 $0.00085

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

Security

Grade A, and why

obsidian-vfs AGENTS.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 5d 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.

AGENTS.md · 45 lines

How it starts

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

AGENTS.md

Project

Virtual file-system sharing Obsidian notes with VSCode and Claude Code.

Architecture

No cross-dependencies between vscode, claude-plugin, cli. Shared logic goes in core. Entry points: CONTRIBUTING.md#architecture.

Hook handler: self-contained bundle at bundle/hook-handler.mjs (tracked in git). Details: CONTRIBUTING.md#hook-handler-bundle.

Build & Verification

Do NOT run bare pnpm ci -- that is pnpm's clean-install and wipes node_modules. Use pnpm run ci.

Always run pnpm format:check before reporting work as done. This is not covered by pnpm run ci and will catch Prettier violations. Fix with pnpm format if needed.

Toolchain, scripts, workflows: CONTRIBUTING.md#toolchain, CONTRIBUTING.md#scripts.

Conventions

Style, file layout, patterns: CONTRIBUTING.md#conventions.

Versioning (bump checklist)

  • VSCode: packages/vscode/package.json
  • Claude plugin: .claude-plugin/marketplace.json, packages/claude-plugin/package.json, .claude-plugin/plugin.json (all three must match)
  • npm packages: packages/core/package.json + packages/cli/package.json (must match)

VSCode: Workspace Folder Architecture

  • Single file:// workspace folder at the vault root for Quick Open (Cmd+P) and Ctrl+Shift+F search. VSCode's file discovery and ripgrep indexer only operate on file:// workspace folders — obs:// workspace folders provide zero discoverability (confirmed by spike, 2026-05-15).
  • files.exclude patterns hide non-autoMount vault content to match the Explorer tree view's visibility. Two-tier split: dotfiles + blockedConfigurationTarget.WorkspaceFolder (<vault>/.vscode/settings.json); non-autoMount dirs + file extension globs → ConfigurationTarget.Workspace. Tracked in context.workspaceState, cleaned up on change or disable. All defaults come from package.json (single source of truth).
  • Vault-side exclusion togglesvault.excludeDotfiles, vault.excludeDotfilePattern, vault.excludeBlocked, vault.gitIgnore. Each independently toggleable at runtime. Settings reference: README.md § Vault.
  • Sub-path exclusion — computed via mount tree (packages/core/src/mount-tree.ts). Controlled by workspace.excludeUnmountedFolders.
  • File-level exclusion — regex on basenames generates {prefix}/*{ext} globs in the folder-scoped files.exclude tier. Gated by workspace.excludeUnmountedFiles toggle.
  • Vault write protectionvault.mode controls obs:// writes ("ro"isReadonly: true; "partial" → autoMount-scoped enforcement). The file:// workspace folder bypasses the provider. Limitations: README.md § Workspace Folder.
  • obs:// FileSystemProvider — registered for tree view, wikilinks, drag-and-drop, watch events; does not back a workspace folder.
  • FileSearchProvider/TextSearchProvider — proposed (unstable) as of @types/[email protected]. Do not use while proposed. Details: README.md § Workspace Folder.

Read the full file on GitHub · 45 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. 5d ago First seen · 45 lines · 854 tokens per session scan A ed66a1745d88

Subscribe to this mod's changes

obsidian-vfs AGENTS.md is an instructions file published in the GitHub repository otaviof/obsidian-vfs (3 stars, last pushed 26d ago), licensed Apache-2.0. It adds 854 tokens to every session, about $0.0043 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