obsidian-cli-rest: Instructions file for Codex

AGENTS.md

obsidian-cli-rest AGENTS.md is an instructions file for Codex, OpenCode from dsebastien/obsidian-cli-rest. It costs 10,290 tokens per session, scanned A, a copy of obsidian-transcriber AGENTS.md, MIT.

A set of coding instructions for an Obsidian community plugin, an extension that adds features to the Obsidian note-taking application.

In plain words
What is it for?
Use it when developing, documenting, or releasing the plugin and its JavaScript, manifest, and optional stylesheet files.
Why use it?
It separates public, user, and technical documentation and defines the checks agents must make before changing the plugin.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is dsebastien/obsidian-cli-rest's own configuration. It tells Codex and OpenCode how to work on obsidian-cli-rest 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-cli-rest configures →

Reuse

Borrowing it

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

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-cli-rest AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/dsebastien/obsidian-cli-rest/agents-md/github.svg)](https://agentmods.dev/instructions/dsebastien/obsidian-cli-rest/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/dsebastien/obsidian-cli-rest/agents-md"><img src="https://agentmods.dev/badge/instructions/dsebastien/obsidian-cli-rest/agents-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 obsidian-cli-rest AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/dsebastien/obsidian-cli-rest/agents-md"><img src="https://agentmods.dev/badge/instructions/dsebastien/obsidian-cli-rest/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 10,290 This file is loaded in full into every session.
When invoked 10,290 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 94% 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.10290 $0.10290
Opus 5.5 $0.04116 $0.04116
Sonnet 5.5 $0.02058 $0.02058
Haiku 4.5 $0.01029 $0.01029

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

Security

Grade A, and why

obsidian-cli-rest 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 1mo 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

94% identical to obsidian-transcriber AGENTS.md — 89 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.

AGENTS.md · 787 lines

How it starts

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

Project Documentation

Documentation surfaces

Three locations, do not mix them:

  • README.md — GitHub landing page; pitch, features, install, quick start.
  • docs/ — end-user guide, published via GitHub Pages (Jekyll).
  • documentation/ — technical documentation for you and coding agents (architecture, domain model, business rules, history, plans).

Project overview

  • Target: Obsidian Community Plugin (TypeScript → bundled JavaScript).
  • Entry point: main.ts compiled to main.js and loaded by Obsidian.
  • Required release artifacts: main.js, manifest.json, and optional styles.css.

Agent Workflow

Session-start checklist

Before making any change, read these in order:

  1. documentation/Business Rules.md — mandatory invariants (see below).
  2. The most recent documentation/history/yyyy-mm-dd.md file — what was last done and any open blockers.
  3. Active plans under documentation/plans/ — what the current direction is.
  4. Relevant sections of node_modules/obsidian/obsidian.d.ts whenever you are about to use an Obsidian API you have not recently used. Do not guess API shapes; they change between versions.

Definition of done

A change is only "done" when all of the following hold:

  • bun run tsc passes with zero errors.
  • bun run lint passes with zero warnings (the repo is configured with --max-warnings 0).
  • bun test passes; new logic has new .spec.ts coverage next to the file it tests.
  • bun run build completes without errors.
  • The day's file in documentation/history/ has been updated with what was done, decisions made, and any open questions.
  • If a plan in documentation/plans/ drove the work, it has been updated or closed.
  • Any user-visible change to behavior, commands, or settings is reflected in README.md and/or docs/.

You cannot self-verify UI behavior — Obsidian is a GUI app and agents do not have a live vault. State explicitly in your final message when a change requires manual runtime verification and what to check. Do not claim a UI feature "works" based solely on a passing build.

Read the full file on GitHub · 787 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. 1mo ago Changed · -4 lines · -35 tokens per session 9f36b2238922
  2. 1mo ago Changed · +55 lines · +1,215 tokens per session d407f1035883
  3. 1mo ago Changed · +3 lines · +322 tokens per session 7d1d865faeeb
  4. 2mo ago First seen · 733 lines · 8,788 tokens per session scan A 670b1f26e047

Subscribe to this mod's changes

obsidian-cli-rest AGENTS.md is an instructions file published in the GitHub repository dsebastien/obsidian-cli-rest (19 stars, last pushed 25d ago), licensed MIT. It adds 10,290 tokens to every session, about $0.0412 per session on Opus 5.5. A static security scan graded it A with 0 findings. It is 94% identical to obsidian-transcriber AGENTS.md, differing in 89 lines, and is treated as a copy.

Related

obsidian-cli-rest AGENTS.md compared with instructions from other repositories

obsidian-cli-rest AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
obsidian-cli-rest AGENTS.mddsebastien/obsidian-cli-restInstructions file1925d agoMITA10,290Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode