obsidian-plugin/sdkasper_lean-obsidian-terminal
1
0
Fork 0
mirror of https://github.com/sdkasper/lean-obsidian-terminal.git synced 2026-07-22 14:30:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
sdkasper_lean-obsidian-term.../docs/uri-handler.md
LeanProductivity edbb51f4ef docs: extract reference sections into standalone docs 
Break down the overly long README into focused reference docs:
- Usage: command and keyboard shortcut reference
- Settings: configuration table and descriptions
- Session Persistence: tab state save/restore details
- Claude Code Integration: integration setup and features
- URI Handler: obsidian:// protocol reference
- Security: security review summary and checksums

README now focuses on Features, Installation, How It Works, and key sections (Feedback, Development, Contributors, License). Users are directed to the docs/ folder for detailed reference material.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-05-11 13:47:02 +03:00

1 KiB
Raw Permalink Blame History

URI Handler

The plugin registers the obsidian://lean-terminal protocol handler, usable from any note link, dashboard button, or external script:

Parameter Description Example
cwd Open a terminal tab in the given directory (URL-encoded path) obsidian://lean-terminal?cwd=%2Fhome%2Fuser%2Fprojects%2Fmy-app
resume Open a terminal tab and run claude --resume <session-id> once the shell is ready (requires Claude integration enabled) obsidian://lean-terminal?resume=<uuid>

The cwd parameter is useful for dashboards and launchers. In an Obsidian note with Dataview JS or a custom button plugin:

app.workspace.openLinkText("obsidian://lean-terminal?cwd=" + encodeURIComponent("/path/to/project"), "");

Or as a plain Markdown link (paths must be URL-encoded):

[Open project terminal](obsidian://lean-terminal?cwd=%2Fpath%2Fto%2Fproject)

If the terminal panel is already open, the URI opens a new tab in the target directory. If it is closed, a fresh panel opens there.