README file from
GithubLucrJournal
LucrJournal is an Obsidian plugin that keeps your trading journal inside the vault you already use. Every position, account, symbol, key level, news item, analysis, and playbook lives as plain Markdown — searchable, linkable, and yours.

Why keep the journal in Obsidian
- Records stay in your vault. No cloud, no lock-in: the files are yours to read, back up, and link however you like.
- A trade is more than a note. Positions link to their account, symbol, key levels, news, market analysis, and playbook, so a review can trace one trade back to the plan and evidence behind it.
- Built for review, not just entry. Dashboards, filters, and playbook statistics turn closed trades into reusable checks.
Features
- Position records — open/close lifecycle with entry, exit, stop, target, and notes; notional, risk, P&L, and R:R derived per instrument type (crypto, futures, CFD).
- Context sections —
News,Key Levels,Confluence, andMarket Analysislinked right inside each position. - Playbooks & criteria — structured checklists written back to Markdown, with win rate and net P&L computed from the positions that actually used them.
- Evidence & OCR — paste or drop screenshots as deduplicated attachments; local OCR recognizes MetaTrader and TradingView screenshots and lets you review the result before it touches the record.
- Charts — candlestick charts with entry/exit markers; futures data comes from Yahoo, crypto from your account's exchange (Binance, Bybit, OKX).
- Symbols — built-in catalog (ES, NQ, EURUSD, XAUUSD…), canonical naming, TradingView-backed logos and types.
- Templates, release notes, English and 简体中文 UI — plus an upgrade gate tied to your LucrTrade account.
Install
LucrJournal is listed in the Obsidian community plugin store (id: lucrjournal).
- Settings → Community plugins → Browse → search LucrJournal → Install → Enable.
- Run the
Open journalcommand and sign in with your LucrTrade account. If your plan does not include journal access, the upgrade screen shows how to enable it — no re-login needed afterwards.
Requires Obsidian 1.11.4 or later. For a manual install, copy manifest.json, main.js, styles.css, onnxruntime-web/, and ocr/ into VaultFolder/.obsidian/plugins/lucrjournal/ and reload Obsidian.
Use with an AI agent
AI coding agents that can run shell commands (Claude Code, Codex, Cursor, …) can keep the journal for you: log a trade you describe, link today's news and confluences, close a position, edit playbooks, or undo their own changes. They work through the plugin's agent API, so links and properties stay consistent, and they never edit the files under LucrJournal/ directly.
Requirements: the Obsidian desktop app 1.12 or later, running, with Settings → General → Command line interface enabled, and LucrJournal signed in in the vault.
Install the skill for your agent:
npx skills add lucrtrade/lucrjournal-obsidian-plugin
Or copy skills/lucrjournal into your agent's skills folder (for Claude Code: ~/.claude/skills/lucrjournal). Then just ask, for example:
I opened a SOL long on Binance at 142 this morning, stop 138, 0.5 SOL, because the higher-timeframe trend is up. CPI came in hot today. Log it in LucrJournal.
Documentation
Guides, field reference, and FAQs: https://lucrjournal.lucrtrade.com/docs/
Development
bun install
bun run dev
bun run build:bundle
bun run test
bun run lint
License
MIT