obshare-cli

obshare-cli

Upload Obsidian Markdown documents to Feishu cloud documents with a workflow built around obshare-cli and the bundled Obsidian companion plugin.

中文说明

mermaid-cli rendering has been removed. The supported Mermaid path is obshare-cli -> Obsidian CLI -> obsidian-plugins bridge -> PNG upload.

Supported Stack

This repository now has three layers:

• obshare-cli: upload Markdown, manage permissions, inspect history, and return JSON for automation
• obsidian-plugins/: the required desktop companion plugin for direct note sharing, runtime binding, shared config/history management, and Mermaid rendering
• Claude Code plugin skills: an agent-facing layer that drives the same CLI + Obsidian workflow

If you want the supported experience, install the CLI and the Obsidian plugin together.

5-Minute Quick Start

1. Create the recommended obsd conda environment

conda create -n obsd python -y
conda run -n obsd python -m pip install --upgrade pip
conda run -n obsd python -m pip install --upgrade obshare-cli
conda run -n obsd obshare-cli --version

2. Install the Obsidian companion plugin

1. Copy obsidian-plugins/ into your vault plugin directory as .obsidian/plugins/obshare-cli/.
2. Enable obshare-cli in Obsidian.
3. Update Obsidian to the latest installer build before testing the CLI bridge.
4. Open Settings -> About -> Advanced and enable Command line interface.
5. Click Register so the obsidian command is available from your terminal.
6. Open the plugin settings.
7. In Environment Configuration, choose the conda (obsd) runtime.
8. Set a shared bridge directory that both Obsidian and obshare-cli can access.

Use these screens as the reference path:

Detailed plugin shell notes live in obsidian-plugins/README.md.

3. Configure Feishu credentials in the CLI

Get the required values from your Feishu Open Platform app and target folder.

Feishu config guidance

conda run -n obsd obshare-cli config set-app-id "cli_xxx"
conda run -n obsd obshare-cli config set-app-secret "xxx"
conda run -n obsd obshare-cli config set-user-id "ou_xxx"
conda run -n obsd obshare-cli config set-folder "fldcnxxx"

4. Configure the Obsidian bridge on the CLI side

Use the same bridge directory that you configured in the plugin settings.

conda run -n obsd obshare-cli config set-obsidian-cli obsidian
conda run -n obsd obshare-cli config set-obsidian-bridge-dir /path/to/shared/bridge
conda run -n obsd obshare-cli config set-obsidian-command-id obshare-cli:process-render-request
conda run -n obsd obshare-cli config show
conda run -n obsd obshare-cli config test

5. Upload your first note

conda run -n obsd obshare-cli upload note.md
conda run -n obsd obshare-cli --json upload note.md

If the note contains Mermaid blocks, obshare-cli writes a render request into the bridge directory, triggers obsidian command id=obshare-cli:process-render-request, waits for the plugin to return a PNG, and then uploads the final document to Feishu.

6. Share directly from Obsidian

After the Feishu config and bridge settings are in place, V0.2.0 lets you share the current note from inside Obsidian itself.

Available entry points:

• Command palette: Share Current Note To Feishu
• File context menu: Share To Feishu
• Ribbon button: Share To Feishu

Share behavior:

• The plugin blocks the flow if the current note has unsaved changes.
• Share permissions are confirmed before upload.
• Upload progress is shown as staged progress in the plugin.
• On success, the plugin shows the Feishu URL and can copy or open it.
• On failure, the plugin shows a summary and can export a .log file to a selected folder.

Command Quick Reference

--json is a global flag. Put it before the subcommand, for example obshare-cli --json upload note.md.