BookStack

# BookStack Skill

**BookStack** 是一个开源的 Wiki 和文档平台。此技能允许您通过 API 管理您的整个知识库——非常适合自动化和集成。

## 功能

- 📚 **书籍 (Books)** – 创建、编辑、删除 - 📑 **章节** – 在书籍中组织内容 - 📄 **页面** – 使用 HTML 或 Markdown 创建/编辑 - 🔍 **全文搜索** – 搜索所有内容 - 📁 **书架** – 将书籍组织到集合中

## 快速开始

```bash # List all books python3 scripts/bookstack.py list_books

# Search the knowledge base python3 scripts/bookstack.py search "Home Assistant"

# Get a page python3 scripts/bookstack.py get_page 123

# Create a new page (Markdown) python3 scripts/bookstack.py create_page --book-id 1 --name "My Page" --markdown "# Title\n\nContent here..." ```

## 所有命令

### 书籍 ```bash python3 scripts/bookstack.py list_books # List all books python3 scripts/bookstack.py get_book <id> # Book details python3 scripts/bookstack.py create_book "Name" ["Desc"] # New book python3 scripts/bookstack.py update_book <id> [--name] [--description] python3 scripts/bookstack.py delete_book <id> ```

### 章节 ```bash python3 scripts/bookstack.py list_chapters # List all chapters python3 scripts/bookstack.py get_chapter <id> # Chapter details python3 scripts/bookstack.py create_chapter --book-id <id> --name "Name" python3 scripts/bookstack.py update_chapter <id> [--name] [--description] python3 scripts/bookstack.py delete_chapter <id> ```

### 页面 ```bash python3 scripts/bookstack.py list_pages # List all pages python3 scripts/bookstack.py get_page <id> # Page preview python3 scripts/bookstack.py get_page <id> --content # With HTML content python3 scripts/bookstack.py get_page <id> --markdown # As Markdown

# Create page (in book or chapter) python3 scripts/bookstack.py create_page --book-id <id> --name "Name" --markdown "# Content" python3 scripts/bookstack.py create_page --chapter-id <id> --name "Name" --html "<p>HTML</p>"

# Edit page python3 scripts/bookstack.py update_page <id> [--name] [--content] [--markdown] python3 scripts/bookstack.py delete_page <id> ```

### 搜索 ```bash python3 scripts/bookstack.py search "query" # Search everything python3 scripts/bookstack.py search "query" --type page # Pages only python3 scripts/bookstack.py search "query" --type book # Books only ```

### 书架 ```bash python3 scripts/bookstack.py list_shelves # List all shelves python3 scripts/bookstack.py get_shelf <id> # Shelf details python3 scripts/bookstack.py create_shelf "Name" ["Desc"] # New shelf ```

## 配置

设置以下环境变量：

```bash export BOOKSTACK_URL="https://your-bookstack.example.com" export BOOKSTACK_TOKEN_ID="your-token-id" export BOOKSTACK_TOKEN_SECRET="your-token-secret" ```

或者在您的网关配置文件中的 `skills.entries.bookstack.env` 下进行配置。

### 创建 API 令牌

1. 登录您的 BookStack 实例 2. 前往 **编辑个人资料** → **API Tokens** 3. 点击 **Create Token** 4. 复制令牌 ID (Token ID) 和密钥 (Secret)

⚠️ 用户需要拥有 **“访问系统 API”** 权限的角色！

## API 参考

- **Base URL**: `{BOOKSTACK_URL}/api` - **Auth Header**: `Authorization: Token {ID}:{SECRET}` - **官方文档**: https://demo.bookstackapp.com/api/docs

---

**作者**: xenofex7 | **版本**: 1.0.2