claudian README

The project's README from github.com/YishenTu/claudian. As one markdown file: README.md.

Claudian

Claudian on Trendshift GitHub stars Obsidian downloads GitHub release License

Preview

An Obsidian plugin that embeds AI coding agents (Claude Code, Codex, Grok, Opencode, Pi, and more to come) in your vault. Your vault becomes the agent's working directory — file read/write, search, bash, and multi-step workflows all work out of the box. Visit claudian.md to learn more.

Features & Usage

Open the chat sidebar from the ribbon icon or command palette. Select text and use the shortcut for inline editing. Everything works like your familiar coding agent, Claude Code, Codex, Grok, Opencode, and Pi — talk to the agent, and it reads, writes, edits, and searches files in your vault.

Inline Edit — Select text or start at the cursor position + hotkey to edit directly in notes with word-level diff preview.

Slash Commands & Skills — Type / or $ for reusable prompt templates or Skills from user- and vault-level scopes.

@mention — Type @ to reference vault files, folders, and Collab member changes. Type # to reference Collab tickets.

Instruction Mode (/instruction) — Refined custom instructions added from the chat input.

MCP Servers — Connect external tools through each coding agent's native CLI-managed MCP configuration.

Tabs & Session Management — Use multiple tabs in single-panel mode or a persistent session manager beside the chat in dual-pane mode.

Collab Mode (Experimental) — Collaborate on shared projects with other Claudian users. Learn more.

Requirements

Installation

  1. Open Obsidian → Settings → Community plugins → Browse
  2. Search for "Claudian" and click Install
  3. Enable the plugin

Or install directly from the community plugin page.

Plugin size and Obsidian Sync

Despite considerable effort to reduce the bundle size, keeping it below 5 MB is no longer practical with the latest Claude Agent SDK. The Obsidian community plugin page may therefore display a large-plugin warning, and Obsidian's official Sync service cannot sync the main plugin file because it supports only files smaller than 5 MB.

If you use Obsidian Sync across multiple desktop devices, install and update Claudian separately on each device instead of relying on Sync to copy the plugin files.

From source (development)

  1. Clone this repository into your vault's plugins folder:

    cd /path/to/vault/.obsidian/plugins
git clone https://github.com/YishenTu/claudian.git
cd claudian

  2. Install dependencies and build:

    npm install
npm run build

  3. Enable the plugin in Obsidian:

    • Settings → Community plugins → Enable "Claudian"

Development

# Watch mode
npm run dev

# Production build
npm run build

Privacy & Data Use

Troubleshooting

The following sections use Claude Code as an example.

Provider CLI not found

If Claudian cannot auto-detect a provider CLI, verify that the CLI is installed and available to GUI applications through PATH. Typical errors include spawn claude ENOENT and Claude CLI not found. This issue is common with Node version managers (nvm, fnm, volta).

Leave the CLI path setting empty first so Claudian can auto-detect the CLI. If auto-detection fails, find the executable path and set it in Settings → Advanced → Claude CLI path.

Platform Command Example Path
macOS/Linux which claude /Users/you/.volta/bin/claude
Windows (native) where.exe claude C:\Users\you\AppData\Local\Claude\claude.exe
Windows (npm) npm root -g {root}\@anthropic-ai\claude-code\cli-wrapper.cjs

Note: On Windows, avoid .cmd and .ps1 wrappers. Use claude.exe for native installs, or cli-wrapper.cjs for package-manager installs. cli.js is only a legacy fallback for older Claude Code npm packages.

Alternative: Add your Node.js bin directory to PATH in Settings → Environment → Custom variables.

npm CLI and Node.js not in the same directory

When using an npm-installed provider CLI, make sure its executable and Node.js are available from the same environment. Check their paths:

dirname $(which claude)
dirname $(which node)

If the paths differ, GUI apps like Obsidian may not find Node.js.

Either:

  1. Install the native binary (recommended).
  2. Add the Node.js path in Settings → Environment: PATH=/path/to/node/bin.

More help

For provider-specific installation and configuration guidance, refer to the provider documentation linked in the Requirements section. If you have a feature request or run into a bug, please submit a GitHub issue.

Architecture

src/
├── main.ts                      # Plugin entry point
├── app/                         # Application services, storage, and lazy Collab infrastructure
├── core/                        # Provider-neutral runtime, registry, and type contracts
│   ├── runtime/                 # ChatRuntime interface and approval types
│   ├── providers/               # Provider registry and workspace services
│   ├── auxiliary/               # Shared provider auxiliary services
│   ├── bootstrap/               # Plugin bootstrap wiring
│   ├── security/                # Approval utilities
│   └── ...                      # commands, prompt, storage, tools, types
├── providers/
│   ├── claude/                  # Claude SDK adaptor, prompt encoding, storage, MCP, plugins
│   ├── codex/                   # Codex app-server adaptor, JSON-RPC transport, JSONL history
│   ├── grok/                    # Grok Build ACP adaptor, native history, models, and tools
│   ├── opencode/                # Opencode adaptor
│   ├── pi/                      # Pi RPC adaptor, model discovery, JSONL history
│   └── acp/                     # Agent Client Protocol shared transport
├── features/
│   ├── chat/                    # Sidebar chat: tabs, controllers, renderers
│   ├── collab/                  # Collab sidebar, review, conflict, and access UI
│   ├── inline-edit/             # Inline edit modal and provider-backed edit services
│   └── settings/                # Settings shell with provider tabs
├── shared/                      # Reusable UI components and modals
├── i18n/                        # Internationalization (10 locales)
├── types/                       # Shared ambient types
├── utils/                       # Cross-cutting utilities
└── style/                       # Modular CSS

Contributing

Issues and focused pull requests are welcome. Issues are the preferred starting point: describe the problem, reproduction steps, and environment clearly so it can be investigated.

Before opening a pull request, please read the contribution guide. Pull requests must explain the problem, the proposed solution, why the approach is appropriate, and how the change was validated. Pull requests that add a new provider are not accepted; the guide explains this maintenance and product-quality boundary in detail.

Star History

Star History Chart

Sponsorship

Kimi (Moonshot AI)

Kimi (Moonshot AI)

Thanks to Kimi (Moonshot AI), our Open Source Friend, for supporting Claudian! With 2.8T parameters, native vision, and a 1-million-token context window, Kimi K3 delivers frontier performance across long-horizon coding, knowledge work, and reasoning.

New users receive bonus API credits equal to 10% of their first successful top-up. Use the discount link for the CN or Global platform. This offer ends September 30, 2026. Claudian receives no affiliate commission from these links.

Ke Holdings Inc. (BEIKE)

MOMA

Claudian is proudly sponsored by Ke Holdings Inc. (BEIKE) and the MOMA team. Their support helps Claudian continue to improve through ongoing development and maintenance.

Want to support Claudian or appear here? Contact me: [email protected].

License

Licensed under the MIT License.

claudian (YishenTu/claudian)

Searching Database…

15.7K ·GitHub
Claudian
Что это такое?Claudian — плагин для Obsidian, который встраивает ИИ-агентов для программирования (Claude Code, Codex, Grok, Opencode, Pi) в ваше хранилище и делает хранилище рабочей папкой агента: он может читать и записывать файлы, искать и выполнять команды bash.
Это отдельное приложение или нужно, чтобы был запущен Obsidian?Это плагин для Obsidian, а не отдельное приложение: он работает внутри настольной версии Obsidian и управляет внешними CLI-инструментами ИИ-агентов, которые у вас уже установлены.
Как мне установить Claudian?Установите его через каталог сторонних плагинов Obsidian: найдите «Claudian», нажмите «Установить» и включите; либо склонируйте репозиторий в папку plugins вашего хранилища и соберите плагин из исходного кода.
Нужно ли мне сначала установить Claude Code или другой CLI?Да — должен быть установлен хотя бы один харнесс (Claude Code CLI, Codex CLI, Grok Build, OpenCode или Pi), а также совместимая подписка или API-провайдер, например OpenRouter, Kimi, GLM или DeepSeek, и Obsidian версии v1.13.0+.
Какие подводные камни при установке мне стоит знать?Сборка плагина теперь весит более 5 МБ из-за Claude Agent SDK, поэтому официальная синхронизация Obsidian Sync её не переносит — устанавливать и обновлять плагин придётся вручную на каждом устройстве. Автоопределение CLI также может не сработать в Windows, если CLI провайдера не добавлен в PATH для графических приложений.
Claudian работает в мобильной версии Obsidian или только на компьютере?Только на компьютере — macOS, Linux и Windows. Мобильная версия не поддерживается, а для Collab Mode дополнительно нужен Git.
Куда уходят данные моего хранилища, когда я использую Claudian?Ваш ввод, прикреплённые файлы, изображения и результаты вызовов инструментов отправляются выбранному провайдеру (Anthropic, OpenAI, xAI или бэкенду, настроенному в OpenCode или Pi); собственной телеметрии у плагина нет.
Что такое Collab Mode?Экспериментальная функция, которая позволяет нескольким пользователям Claudian совместно работать над общим проектом; данные проекта в Git и служебные метаданные синхронизируются напрямую между устройствами участников по локальной сети, без участия облачного сервиса Claudian.
Что делает Inline Edit?Выделите текст или поставьте курсор и нажмите горячую клавишу — агент отредактирует заметку прямо на месте, а перед применением изменений вы увидите предпросмотр правок по словам.
Можно ли подключить MCP-серверы к Claudian?Да — MCP-серверы настраиваются через собственную конфигурацию MCP каждого ИИ-агента, которой управляет его CLI, а не через отдельную настройку Claudian.
Почему мейнтейнер не принимает PR с добавлением новых провайдеров агентов?В руководстве для контрибьюторов прямо сказано, что это граница поддержки и качества продукта, поэтому новые интеграции провайдеров не принимаются как pull request от сообщества.
What are similar projects?obsidian-git, operator-memory, pstack, cc-switch, overmind, plannotator, claude-obsidian, obsidian-second-brain
Which topics is it in?obsidian-plugin, diff, pi, obsidian, grok, ide, note-taking, opencode, model-context-protocol, knowledge-base, anthropic, coding-agent
Creator
YishenTu
Size
33.2 MB
Stars
15.7K
Updated
CommitOct 19Release2.3.24Oct 18
Age
10mo
Commits · 90 Days