obsidian-agentic-chat AGENTS.md

AGENTS.md

Fast Feedback Loop

Use ~/MyTestVault as the local dogfood vault unless the user names another vault.

Install the current built plugin into a vault:

npm run install:local -- ~/MyTestVault

Run the fastest Obsidian development loop:

npm run dev:vault -- ~/MyTestVault

dev:vault installs real plugin files under ~/MyTestVault/.obsidian/plugins/agentic-chat/, creates .hotreload, and writes esbuild output directly to that plugin directory. For automatic JS reloads inside Obsidian, install and enable pjeby/hot-reload in the same vault. If hot reload is unavailable, reload manually from Obsidian DevTools:

await app.plugins.disablePlugin("agentic-chat");
await app.plugins.enablePlugin("agentic-chat");

Use the one-command dogfood loop when actively stabilizing:

npm run dogfood -- ~/MyTestVault

dogfood enables the local plugin in the vault, enables any installed hot-reload plugin whose manifest matches "hot reload", starts the direct-to-vault esbuild watcher, opens the vault through Obsidian's URI handler when available, and tails local session JSONL plus e2e artifact text/JSON. Use --once --no-open --no-tail for a non-interactive build/install check.

Run local verification in this order while iterating:

npm run verify:fast

That command expands to:

npm run typecheck
npm run lint
npm test
npm run test:e2e -- --spec test/e2e/specs/smoke.e2e.ts

npm run test:e2e uses scripts/run-e2e.ts: it resolves the matching obsidian-launcher chromedriver, starts it on a fixed low localhost port (9515-9520), and points WDIO at it with WDIO_SKIP_DRIVER_SETUP=1. This avoids WSL/proxy failures where WDIO's random high chromedriver port exits with bind() failed: Address already in use / IPv6 port not available. To run the full local suite without spending tokens, clear the live key so the model-backed guardrail spec skips:

AGENTIC_CHAT_API_KEY= npm run test:e2e