Lark Wiki Sync

Sync one or more Lark Wiki spaces into your Obsidian vault. Uses lark-cli as the transport so auth, scopes, and API coverage are handled upstream — this plugin adds the Obsidian-side UX (ribbon button, setup wizard, paste-a-link, conflict-aware sync, image download).

Status: v0.0.10 — pull works end-to-end across multiple spaces, with full-tree pagination, folder mirroring, GFM-table rendering, and image attachments. Push exists but is unverified end-to-end. Three-way conflict modal still falls back to a .remote.conflict.md sidecar.

Features

• Multi-space sync. Configure as many Lark Wiki spaces as you want; each lives in its own self-contained subfolder under a single local root (default 📥 Lark).
• Setup wizard. Verify lark-cli, pick a space from a dropdown, or paste any wiki URL and the plugin resolves the space + root node for you.
• Full-tree pull with pagination. Walks every descendant up to depth 20, paginates wiki nodes list automatically.
• Native Obsidian markdown. Lark-flavoured tags (<lark-table>, <text>, etc.) get converted to GFM pipe tables and clean markdown.
• Inline images. <image token="…"/> references download via lark-cli docs +media-download into _attachments/<token>.<ext> and embed as ![[<token>.<ext>]]. Cached across syncs.
• 3-way diff classification. Per-file lastSyncedHash enables proper conflict detection (skip / pull / push / conflict / reconcile). Sync state is keyed by Lark nodeToken, so it survives any future path-mapping changes.
• Pre-sync plan modal. Every sync pauses with a plan view grouped by space — pulls / pushes / conflicts / reconciles, with collapsible per-file lists. Three buttons: Cancel, Pull only (skip pushes), Apply all. Toggle in settings.
• Per-space status in settings. Each configured space row shows file count, per-space last-sync time (relative), and a Sync just this button to sync that space alone.
• Live progress notice. While syncing, the Notice updates in real time: Lark Wiki Sync — Nexus Wiki: ↓ pulling 12/48 · FRD.md.
• Visual wizard stepper. Setup wizard now shows a numbered stepper across the top instead of a plain "Step 2 of 6" line. The auth-verify result lands inline under the button (no more modal-then-Notice juggling).
• Per-file error visibility. If any pull/push/conflict step fails (missing scope, rate limit, malformed content), a results modal pops up after sync listing every failure with the actual lark-cli error message, so you don't have to spelunk through the dev console.
• Conflict resolution modal. When the conflict policy is "ask" and both sides have changed since last sync, a modal lists every conflicting file with line counts and three radio choices: Keep local (push), Keep remote (pull), or Save sidecar (default; non-destructive). Pick per file, click Apply.
• Lossless push round-trip. Pipe tables you edit locally are rewritten as <lark-table> and pulled image embeds (![[<token>.<ext>]]) become <image token="..."/> before they hit Lark's update API, so structure survives the round trip. Image embeds whose target is not a known Lark token are left alone (newly-pasted local images aren't yet uploaded — that's a future item).
• Wikilink conversion (pull). Inter-doc links inside pulled docs (https://<tenant>.feishu.cn/wiki/<node_token>) are rewritten to [[Target Doc]] Obsidian wikilinks when the destination is already in the sync state. Click → jumps to the synced file; backlinks panel works.
• Auto-sync timer. Set "Auto-sync interval" in settings to run a sync every N minutes. Plan modal still gates the actual changes if "Confirm before sync" is on.
• Per-file opt-out. Add lark_sync: false to a file's frontmatter to skip just that file on every sync without removing it from either side. Useful for in-progress drafts you don't want pushed yet.
• Ignore patterns. Glob patterns (one per line in settings) skip matching paths globally. * matches anything except /; ** matches anything including /.
• One-click sync. Ribbon icon (Lucide sync) and command palette entries.

Prerequisites

1. lark-cli

This plugin is a thin Obsidian-side wrapper. All Lark/Feishu API calls are made by lark-cli, an open-source CLI maintained by the Larksuite team. The plugin shells out to it for every list, fetch, update, and media download — so auth, scopes, rate limiting, and API coverage live upstream.

Install (requires Node 18+):

npm install -g @larksuite/cli
# verify it's on your PATH
lark-cli --version

Initial setup (one-time per machine):

lark-cli config init    # set your tenant + app credentials, follow the prompts

See the larksuite/cli README for full options (Feishu vs. Lark, app vs. tenant credentials, MCP integration).

Authorize the right scopes for what you want this plugin to do:

# pull-only (read tree, fetch doc bodies, download images)
lark-cli auth login --scope "wiki:space:retrieve wiki:node:retrieve docx:document:readonly drive:drive:readonly"

# bidirectional (above + write back to Lark on push)
lark-cli auth login --scope "wiki:space:retrieve wiki:node:retrieve docx:document:readonly docx:document drive:drive:readonly"

When the plugin hits a missing scope, the post-sync results modal will tell you exactly which scope to add and give you the command to copy-paste.

2. Obsidian desktop

isDesktopOnly: true — the plugin uses Node's child_process.spawn to run lark-cli. iOS / Android Obsidian don't expose that, so they're not supported.

Install via BRAT

1. Install the BRAT plugin in Obsidian.
2. BRAT → Add beta plugin → fszlnwr/obsidian-lark-wiki-sync.
3. Enable Lark Wiki Sync in Community plugins.
4. Click the ribbon icon → run the setup wizard. Paste a Lark wiki link in the Source step and the plugin will resolve everything.

Install (dev)

git clone https://github.com/fszlnwr/obsidian-lark-wiki-sync.git
cd /path/to/your/vault/.obsidian/plugins
ln -s /absolute/path/to/obsidian-lark-wiki-sync ./lark-wiki-sync
cd lark-wiki-sync
npm install
npm run dev        # watches main.ts → main.js

Then in Obsidian: Settings → Community plugins → reload → enable "Lark Wiki Sync".

Architecture

main.ts                          Plugin entry, ribbon, commands, settings migration
src/settings.ts                  Settings schema (spaces[]) + settings tab
src/ui/SetupWizardModal.ts       Add-a-space wizard (dropdown OR paste-a-link)
src/lark/LarkCli.ts              Shell-out wrapper around lark-cli
src/sync/SyncEngine.ts           Per-space pull/push/conflict orchestration
src/state/StateStore.ts          Per-file hash + last-sync timestamps
src/util/hash.ts                 SHA-1 helper
src/util/parseWikiUrl.ts         Lark URL → node_token parser
src/util/larkToObsidianMd.ts     Lark-flavoured MD → Obsidian MD converter (pull)
src/util/obsidianToLarkMd.ts     Obsidian MD → Lark-flavoured MD converter (push)

File layout in your vault

📥 Lark/
  Nexus Wiki/
    FRD.md
    FSD/
      Loyalty engine spec.md
    _attachments/
      <image-token>.jpg
  Another Wiki Space/
    ...
    _attachments/
      ...

Each space is fully self-contained — delete its folder and everything for that space is gone, no orphans.

Sync classification (per file)

For each docx node, compare three hashes:

Special branches when there is no prior lastSyncedHash (first sync of a node, or after a reset):

• Local file absent → pull (new download).
• Local file present, hash matches remote → reconcile (silently adopt the existing file as the baseline; no I/O).
• Local file present, hash differs → conflict (real first-sync collision).

lastSyncedHash is the common ancestor. The remote hash is computed AFTER the Lark→Obsidian markdown transform, so re-pulling the same Lark content produces a stable hash. State is keyed by nodeToken, so renaming localRoot or restructuring folders does not orphan it.

Settings tab

• Wiki spaces — list of currently-synced spaces with a Remove button each. "Add a wiki space" opens the wizard.
• Connection — lark-cli path (blank = use PATH), identity (user / bot).
• Sync behaviour — local root, sync direction (pull / push / bidirectional), conflict policy, auto-sync interval.
• Maintenance — last-synced timestamp, "Reset sync state" wipes cached hashes (use after a major layout change).

Roadmap

• v0.0.1 — scaffold: pull one docx node, record state
• v0.0.5 — full space pull with folder mirroring + pagination
• v0.0.6 — Lark-flavoured MD → Obsidian MD conversion (tables, images placeholder)
• v0.0.7 — inline image download (was v0.5 in the original plan)
• v0.0.9 — per-space subfolder, default root 📥 Lark
• v0.0.10 — multi-space configuration
• v0.0.11 — push path actually fires (state keyed by nodeToken, reconcile branch); push confirmation modal
• v0.0.12 — per-action error surfacing (results modal lists every failure with the real lark-cli message)
• v0.0.13 — push uses --mode overwrite (lark-cli's replace_all mode is selection-scoped despite the name)
• v0.1.0 — inverse Obsidian→Lark transform: pipe tables → <lark-table>, ![[<token>.<ext>]] → <image token="..."/> on push
• v0.0.15 — UI polish: pre-sync plan modal, per-space status + per-space sync button, live progress notice, wizard stepper
• v0.0.16 — wikilink conversion on pull: Lark wiki URLs inside docs become [[Target]] when the destination is synced
• v0.0.17 — auto-sync timer + lark_sync: false frontmatter flag + glob ignore patterns
• v0.0.18 — conflict resolution modal: per-file Keep local / Keep remote / Save sidecar
• v0.0.19 — community-plugin lint fixes: MIT LICENSE file added, description rewritten to drop the word "Obsidian"
• v0.0.20 — community-plugin lint fixes round 2: drop top-level <h2> in favour of section .setHeading(); move inline style.width to a CSS class
• v0.3.0 — wikilink reverse direction (Obsidian [[…]] → Lark URL on push), needs tenant host capture
• v0.4.0 — embedded <sheet> rendering / link
• v1.0.0 — ignore patterns, per-file lark_sync: false frontmatter flag, auto-sync timer, polish

Testing strategy

• Unit: none yet — the converter (larkToObsidianMd.ts) and URL parser (parseWikiUrl.ts) are pure functions and would benefit from a small test harness.
• Integration: run against a throwaway Wiki space.
• E2E: dry-run mode (Cmd+P → "Lark Wiki Sync — preview changes (dry run)") prints intended actions without applying.

License

MIT