obsidian-cli-rest AGENTS.md

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.