BookStack 技能

BookStack 是一个开源的 Wiki 与文档管理平台。本技能支持通过 API 全面管理您的知识库，非常适合自动化与系统集成。

功能特性

• 📚 书籍（Books） — 创建、编辑、删除
• 📑 章节（Chapters） — 在书籍内组织内容
• 📄 页面（Pages） — 支持以 HTML 或 Markdown 格式创建/编辑
• 🔍 全文搜索（Full-text search） — 跨全部内容进行检索
• 📁 书架（Shelves） — 将书籍归类为集合

快速上手

# 列出所有书籍
python3 scripts/bookstack.py list_books

# 搜索知识库
python3 scripts/bookstack.py search "Home Assistant"

# 获取指定页面
python3 scripts/bookstack.py get_page 123

# 创建新页面（Markdown 格式）
python3 scripts/bookstack.py create_page --book-id 1 --name "My Page" --markdown "# TitlennContent here..."

全部命令列表

书籍（Books）

python3 scripts/bookstack.py list_books                    # 列出所有书籍
python3 scripts/bookstack.py get_book                  # 获取书籍详情
python3 scripts/bookstack.py create_book "Name" ["Desc"]   # 创建新书籍
python3 scripts/bookstack.py update_book  [--name] [--description]
python3 scripts/bookstack.py delete_book 

章节（Chapters）

python3 scripts/bookstack.py list_chapters                 # 列出所有章节
python3 scripts/bookstack.py get_chapter               # 获取章节详情
python3 scripts/bookstack.py create_chapter --book-id  --name "Name"
python3 scripts/bookstack.py update_chapter  [--name] [--description]
python3 scripts/bookstack.py delete_chapter 

页面（Pages）

python3 scripts/bookstack.py list_pages                    # 列出所有页面
python3 scripts/bookstack.py get_page                  # 获取页面预览
python3 scripts/bookstack.py get_page  --content       # 同时返回 HTML 内容
python3 scripts/bookstack.py get_page  --markdown      # 以 Markdown 格式返回

# 创建页面（指定所属书籍或章节）
python3 scripts/bookstack.py create_page --book-id  --name "Name" --markdown "# Content"
python3 scripts/bookstack.py create_page --chapter-id  --name "Name" --html "
HTML
"

# 编辑页面
python3 scripts/bookstack.py update_page  [--name] [--content] [--markdown]
python3 scripts/bookstack.py delete_page 

搜索（Search）

python3 scripts/bookstack.py search "query"                # 全局搜索（所有类型）
python3 scripts/bookstack.py search "query" --type page    # 仅搜索页面
python3 scripts/bookstack.py search "query" --type book    # 仅搜索书籍

书架（Shelves）

python3 scripts/bookstack.py list_shelves                  # 列出所有书架
python3 scripts/bookstack.py get_shelf                 # 获取书架详情
python3 scripts/bookstack.py create_shelf "Name" ["Desc"]  # 创建新书架

配置说明

请设置以下环境变量：

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 Token

1. 登录您的 BookStack 实例
2. 进入 Edit Profile → API Tokens
3. 点击 Create Token
4. 复制生成的 Token ID 和 Secret

⚠️ 当前用户角色必须具备 "Access System API" 权限！

API 参考

• 基础 URL: {BOOKSTACK_URL}/api
• 认证请求头: Authorization: Token {ID}:{SECRET}
• 官方文档: https://demo.bookstackapp.com/api/docs

作者: xenofex7 | 版本: 1.0.2