siyuan-skill

# 核心价值

**提供 AI Agent 可快速接入思源笔记的 skill 方案**
**为 AI Agent 团队提供统一、结构化、可检索的共享知识库**

## 适用场景
✅ 团队规范、项目知识、可复用技能
✅ 需要多 Agent 共享的知识
✅ 需要长期存储和检索的内容

## 不适用场景
❌ 日常互动记录、个人学习反思
❌ 临时笔记、代码版本管理
❌ 实时协作编辑

## 关键原则
- **思源笔记** = 共享知识库
- **memory 文件** = 私密记录
- **MEMORY.md** = 长期记忆

---

# 重要约束

**必须使用 CLI 命令来操作思源笔记**
**禁止自动修改配置文件与本技能相关环境变量配置**
**禁止直接调用 API**
**禁止使用脚本调用、引用 index.js**
**禁止使用脚本调用、引用指令文件**

---

# 快速开始

## 使用方式

```bash
# 方式 1：进入技能目录运行
cd <skills-directory>/siyuan-skill
node siyuan.js <command>

# 方式 2：使用 npm link 全局安装（推荐）
npm link -g
siyuan <command>

# 方式 3：直接指定路径运行
node <skills-directory>/siyuan-skill/siyuan.js <command>
```

## 查看帮助

```bash
# 查看所有可用命令
siyuan help

# 查看特定命令的详细帮助
siyuan help search
siyuan help create
```

---

# 命令列表

使用 `siyuan help` 查看所有可用命令和详细说明。

**常用命令**：
- `nb` - 获取笔记本列表
- `new` - 创建文档
- `edit` - 更新文档
- `rm` - 删除文档
- `find` - 搜索内容（支持向量搜索）
- `mv` - 移动文档
- `path` - 转换 ID 和路径
- `index` - 索引文档到向量数据库
- `nlp` - NLP 文本分析

详细命令文档请查看 [doc/commands/](doc/commands/) 目录。

---

# 配置

## 环境变量（优先级最高）

```bash
export SIYUAN_BASE_URL="http://127.0.0.1:6806"
export SIYUAN_TOKEN="your-api-token"
export SIYUAN_DEFAULT_NOTEBOOK="your-notebook-id"
export SIYUAN_PERMISSION_MODE="all"
export SIYUAN_NOTEBOOK_LIST="notebook-id1,notebook-id2"
```

## 配置文件

编辑 `config.json` 文件：

```json
{
  "baseURL": "http://127.0.0.1:6806",
  "token": "your-api-token",
  "defaultNotebook": "your-notebook-id",
  "permissionMode": "all"
}
```

**获取配置信息**：
1. 打开思源笔记 → 设置 → 关于 → 复制 API Token
2. 使用 `siyuan notebooks` 获取笔记本 ID

---

# 注意事项

1. **首次使用**需要配置思源笔记 API 地址...

# Siyuan Skill

[![GitHub](https://img.shields.io/badge/GitHub-Source-green.svg)](https://github.com/dazexcl/siyuan-skill)
[![Version](https://img.shields.io/badge/version-1.3.2-blue.svg)](https://github.com/dazexcl/siyuan-skill)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/dazexcl/siyuan-skill)
[![Node](https://img.shields.io/badge/node->14-green.svg)](https://github.com/dazexcl/siyuan-skill)

> **Siyuan Notes 命令行工具，提供便捷的命令行操作方式，支持笔记本管理、文档操作、内容搜索等功能。**

[![Features](https://img.shields.io/badge/features-Vector%20Search-blue.svg)](https://github.com/dazexcl/siyuan-skill)
[![Features](https://img.shields.io/badge/features-NLP-blue.svg)](https://github.com/dazexcl/siyuan-skill)


`纯node环境` `无需任何依赖` `开箱即用` `agent自动接入` `灵活拔插` `黑白名单` `渐进式披露`
## 核心价值

**提供ai agent可快速接入siyuan笔记的的skill方案**

**为 AI Agent 团队提供统一、结构化、可检索的共享知识库**

### 适用场景

✅ 团队规范、项目知识、可复用技能  
✅ 需要多 Agent 共享的知识  
✅ 需要长期存储和检索的内容  

### 不适用场景

❌ 日常互动记录、个人学习反思  
❌ 临时笔记、代码版本管理  
❌ 实时协作编辑  

### 关键原则

- **思源笔记** = 共享知识库
- **memory 文件** = 私密记录
- **MEMORY.md** = 长期记忆

##  目录

- [核心价值](#核心价值)
- [快速开始](#快速开始)
- [配置说明](#配置说明)
- [环境变量](#环境变量)
- [使用方式](#使用方式)
- [常用命令](#常用命令)
- [书写规范](#书写规范)
- [权限管理](#权限管理)
- [故障排除](#故障排除)
- [贡献](#贡献)

---

## 快速开始

### 安装 Skill

**方式 1：克隆到 Skills 目录（推荐）**

```bash
# 进入AI工具的 Skills 目录
cd %USERPROFILE%/skills

# 克隆仓库
git clone https://github.com/dazexcl/siyuan-skill.git

# 进入技能目录
cd siyuan-skill

```

**方式 2：手动复制**

```bash
# 将整个 siyuan-skill 目录复制到 Skills 目录
```

**验证安装**

```bash
# 进入技能目录
cd %USERPROFILE%/skills/siyuan-skill

# 测试命令
node siyuan.js help
```

### 配置

#### 方式 1：使用环境变量（推荐）

``...