🎁 Get the FREE AI Skills Starter Guide β€” Subscribe β†’
BytesAgainBytesAgain
BytesAgain β€Ί Skills β€Ί BookStack
πŸ¦€ ClawHub

BookStack

by @xenofex7

BookStack Wiki & Documentation API integration. Manage your knowledge base programmatically: create, read, update, and delete books, chapters, pages, and shelves. Full-text search across all content. Use when you need to: (1) Create or edit wiki pages and documentation, (2) Organize content in books and chapters, (3) Search your knowledge base, (4) Automate documentation workflows, (5) Sync content between systems. Supports both HTML and Markdown content.

Versionv1.0.3
Downloads3,195
Installs2
Stars⭐ 3
#clawhub
TERMINAL
clawhub install bookstack

πŸ“– About This Skill

name: bookstack description: "BookStack Wiki & Documentation API integration. Manage your knowledge base programmatically: create, read, update, and delete books, chapters, pages, and shelves. Full-text search across all content. Use when you need to: (1) Create or edit wiki pages and documentation, (2) Organize content in books and chapters, (3) Search your knowledge base, (4) Automate documentation workflows, (5) Sync content between systems. Supports both HTML and Markdown content." metadata: openclaw: requires: env: - BOOKSTACK_URL - BOOKSTACK_TOKEN_ID - BOOKSTACK_TOKEN_SECRET

BookStack Skill

BookStack is an open-source wiki and documentation platform. This skill lets you manage your entire knowledge base via API – perfect for automation and integration.

Features

  • πŸ“š Books – create, edit, delete
  • πŸ“‘ Chapters – organize content within books
  • πŸ“„ Pages – create/edit with HTML or Markdown
  • πŸ” Full-text search – search across all content
  • πŸ“ Shelves – organize books into collections

    • Quick Start

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

    All Commands

    Books

    python3 scripts/bookstack.py list_books                    # List all books
python3 scripts/bookstack.py get_book                  # Book details
python3 scripts/bookstack.py create_book "Name" ["Desc"]   # New book
python3 scripts/bookstack.py update_book  [--name] [--description]
python3 scripts/bookstack.py delete_book

    Chapters

    python3 scripts/bookstack.py list_chapters                 # List all chapters
python3 scripts/bookstack.py get_chapter               # Chapter details
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                    # List all pages
python3 scripts/bookstack.py get_page                  # Page preview
python3 scripts/bookstack.py get_page  --content       # With HTML content
python3 scripts/bookstack.py get_page  --markdown      # As Markdown
    Create page (in book or chapter)
    
python3 scripts/bookstack.py create_page --book-id  --name "Name" --markdown "# Content"
python3 scripts/bookstack.py create_page --chapter-id  --name "Name" --html "
    HTML
    "
    Edit page
    
python3 scripts/bookstack.py update_page  [--name] [--content] [--markdown]
python3 scripts/bookstack.py delete_page

    Search

    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

    Shelves

    python3 scripts/bookstack.py list_shelves                  # List all shelves
python3 scripts/bookstack.py get_shelf                 # Shelf details
python3 scripts/bookstack.py create_shelf "Name" ["Desc"]  # New shelf

    Configuration

    Set the following environment variables:

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

    Or configure via your gateway config file under skills.entries.bookstack.env.

    Create an API Token

    1. Log in to your BookStack instance 2. Go to Edit Profile β†’ API Tokens 3. Click Create Token 4. Copy the Token ID and Secret

    ⚠️ The user needs a role with "Access System API" permission!

    API Reference

  • Base URL: {BOOKSTACK_URL}/api
  • Auth Header: Authorization: Token {ID}:{SECRET}
  • Official Docs: https://demo.bookstackapp.com/api/docs

    • Author: xenofex7 | Version: 1.0.2

    πŸ’‘ Examples

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

    βš™οΈ Configuration

    Set the following environment variables:

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

    Or configure via your gateway config file under skills.entries.bookstack.env.

    Create an API Token

    1. Log in to your BookStack instance 2. Go to Edit Profile β†’ API Tokens 3. Click Create Token 4. Copy the Token ID and Secret

    ⚠️ The user needs a role with "Access System API" permission!