Name: Niki-AI
Author: KeloYuan

在 Obsidian 侧边栏中使用 Claude Code，享受流畅的 AI 辅助写作体验。
Embed Claude Code into your Obsidian sidebar — write, edit, and create with AI assistance.

🎯 Why Niki AI?

🧬 Deep Integration

不是简单的 API 调用 —— 直接将 Claude Code CLI 嵌入 Obsidian 侧边栏，获得完整的 AI 编码能力。

🔒 Privacy First

数据始终在本地，AI 直接操作你的 Vault 文件。支持自定义 API 端点，完全掌控你的数据流。

⚡ Zero Friction

@ 引用文件、拖拽添加上下文、一键插入回复、代码差异预览 —— 每个交互都经过精心设计。

🛡️ Safe by Default

AI 修改文件后一键撤销，多文件批量恢复。你永远有后悔药。

✨ Features

Core Capabilities

Feature	Description
🎨 Sidebar Chat UI	原生 Obsidian 界面风格，无缝融入你的工作流
📝 Smart Context	自动包含当前笔记或指定文件内容作为上下文
⌨️ @ File Reference	输入 `@` 或拖拽文件，快速添加多文件上下文
🔄 Undo Support	AI 修改文件后一键恢复，支持多文件批量撤销
💬 Multi-Thread	创建多个独立对话话题，管理工作互不干扰
📋 Diff Preview	代码块差异可视化，审查后一键应用变更
🎯 One-Click Insert	将 AI 回复直接插入当前笔记光标位置

Powered by Claude Code

支持 Opus / Sonnet / Haiku 模型切换
完整的 MCP 工具链 支持
自定义 系统提示词 和 工作目录
npm 版本 & 原生版本 自动检测
支持自定义 API 端点（兼容第三方代理）

📦 Installation

方式一：从 Release 安装（推荐）

下载最新 Release

解压到你的 Vault：

<your-vault>/.obsidian/plugins/niki-ai/

重启 Obsidian → 设置 → 第三方插件 → 启用 Niki AI

方式二：从源码构建

git clone https://github.com/KeloYuan/Niki-AI.git
cd Niki-AI
npm install
npm run dev    # 开发模式
npm run build  # 生产构建

前置要求：安装 Claude Code CLI

npm 安装（推荐）：

npm install -g @anthropic-ai/claude-code

官方脚本安装：

curl -fsSL https://claude.ai/install.sh | bash

特性	npm 安装	官方脚本
依赖	Node.js	无
性能	较好	最优
更新方式	`npm update`	自动更新
跨平台	✅ 全平台	Unix-like
安装大小	~100MB	~50MB

⚙️ Configuration

Claude Code 配置

编辑 ~/.claude/settings.json：

{
  "permissions": {
    "defaultMode": "bypassPermissions"
  }
}

完整配置示例（含自定义 API）

{
  "env": {
    "ANTHROPIC_AUTH_TOKEN": "your-api-key",
    "API_TIMEOUT_MS": "3000000",
    "ANTHROPIC_BASE_URL": "https://your-api-endpoint.com"
  },
  "permissions": {
    "defaultMode": "bypassPermissions"
  },
  "model": "opus"
}

插件设置

Obsidian → 设置 → 插件 → Niki AI

设置项	说明	默认值
Claude command	CLI 命令模板	`claude -p "{prompt}"`
Default prompt	系统提示词	(空)
Working directory	工作目录	当前 Vault 路径
Claude 版本选择	CLI 版本检测策略	自动检测

💡 Tips & Tricks

@ 引用文件     → 输入 @ 弹出文件选择器
拖拽文件       → 直接拖入输入框添加上下文
多话题管理     → 左上角下拉切换/新建/删除话题
撤销修改       → AI 改完文件后点击"撤销"一键恢复
代码差异       → 点击"查看变更"审查后"应用全部"
一键插入       → AI 回复直接插入当前笔记光标处

🛠️ Development

Niki-AI/
├── src/
│   ├── main.ts          # 插件入口
│   ├── settings.ts      # 设置面板
│   ├── view.ts          # 聊天视图
│   ├── claude.ts        # Claude Code 集成
│   └── utils/           # 工具函数
├── styles.css           # 样式
├── manifest.json        # 插件清单
└── esbuild.config.mjs   # 构建配置

npm install        # 安装依赖
npm run dev        # 开发模式（自动 watch）
npm run build      # 生产构建

❓ FAQ

没有任何输出？

确认 Claude command 设置正确，并在终端中测试命令是否可用。

提示找不到命令？

检查 PATH 或使用绝对路径，常见位置：

~/.npm-global/bin/claude
/opt/homebrew/bin/claude

AI 说修改了但文件没变？

确保 Claude Code 配置中设置了 "defaultMode": "bypassPermissions"。

📊 Star History

📄 License

MIT © KeloYuan

If you find this plugin helpful, consider giving it a ⭐ — it means a lot!