Skip to content

README.en.md

Latest commit

 

History

History
60 lines (40 loc) · 3.82 KB

README.en.md

File metadata and controls

60 lines (40 loc) · 3.82 KB
Raw

Workbuddian

Release Downloads CI Obsidian plugin License: MIT

中文 | English

Primary audience is Chinese-speaking Obsidian users. The canonical README is in Simplified Chinese (中文); this English page is a condensed entry point.

Workbuddian is an Obsidian community plugin that turns your local CodeBuddy CLI or Hermes agent into an AI chat agent living inside your vault — chat, reference notes with @, stream replies, and edit your writing without ever switching windows. Dual backends, one panel.

⚠️ Desktop only (Windows / macOS), requires Obsidian 1.7.2+. Linux is not supported yet.

Features

  • Dual backends — local CodeBuddy CLI or Hermes agent, both with full agent features (tools / approval cards / thinking / usage / forking) over ACP. Hermes falls back to a plain-chat HTTP lite mode when the local CLI is missing or a remote gateway is configured; auto-discovers gateway URL + API key from ~/.hermes.
  • Streaming chat in the sidebar or a full-width main-area tab, with collapsible thinking / tool-call cards and Markdown rendering.
  • @ references anything — subagents (@Agent), MCP servers (@mcp), notes (@[[note]]), or any file, from one dropdown.
  • Approvals in the bubble — Write / Edit / Bash / MCP tools ask permission on a card; plan mode continues in the same turn.
  • Line-level diffs with one-click undo for vault edits, guarded by three safety checks.
  • Conversation forking and two truly isolated panels (sidebar + main area, separate sessions).
  • Visual MCP server management with two-way JSON sync; custom subagents in JSON.
  • Bilingual UI (中文 / English) with instant switching.
  • Beyond using the CLI directly — visual interface, approval cards, one-click undo, and panel integration all live inside Obsidian.

Installation

Prerequisites: Obsidian 1.7.2+ (desktop), Windows or macOS, and the WorkBuddy desktop app (≥ 5.0.5) which bundles the CodeBuddy CLI.

  1. In Obsidian: Settings → Community plugins → Browse.
  2. Search "Workbuddian" → Install → Enable.

Or via BRAT with jiang198012/workbuddian.

Quick Start

  1. Click the robot ribbon icon or run "Workbuddian: Open chat panel".
  2. If the plugin can't find CodeBuddy / Node.js, run the environment-setup prompt once in WorkBuddy (full prompt in the Chinese README).
  3. Send your first message.

Vault permissions: send the full contents of 提示词-授予Vault读写权限.md to WorkBuddy/CodeBuddy once, then fully quit and reopen it.

Documentation

The complete documentation (usage, settings, auto-discovery, FAQ, changelog) is maintained in Simplified Chinese: README.md — the canonical source.

Support

File bugs or feature requests on GitHub Issues.

License

MIT. See LICENSE.