BookStack 技能

BookStack是一款开源的维基和文档平台。此技能让您可以通过 API 管理整个知识库——非常适合自动化和集成。

功能特性

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

快速开始

# 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..."

所有命令

书籍

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>

章节

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>

页面

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>

搜索

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

书架

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

配置

设置以下环境变量：

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令牌
3. 点击创建令牌
4. 复制令牌ID和密钥

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

API参考

• 基础URL：{BOOKSTACK_URL}/api
• 认证头：授权：令牌 {ID}:{SECRET}
• 官方文档：https://demo.bookstackapp.com/api/docs

作者：xenofex7 |版本：1.0.2