โœ“ Verified ๐Ÿ“ File Management โœ“ Enhanced Data

Bookstack

BookStack Wiki & Documentation API integration.

Rating
4.3 (409 reviews)
Downloads
862 downloads
Version
1.0.0

Overview

BookStack Wiki & Documentation API integration.

โœจKey Features

1

๐Ÿ“š Books โ€“ create, edit, delete

2

๐Ÿ“‘ Chapters โ€“ organize content within books

3

๐Ÿ“„ Pages โ€“ create/edit with HTML or Markdown

4

๐Ÿ” Full-text search โ€“ search across all content

5

๐Ÿ“ Shelves โ€“ organize books into collections

Complete Documentation

View Source โ†’

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

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

All Commands

Books

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>

Chapters

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>

Pages

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>

Search

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

Shelves

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

Configuration

Set the following environment variables:

bash
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

  • Log in to your BookStack instance
  • Go to Edit Profile โ†’ API Tokens
  • Click Create Token
  • 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

Installation

Terminal bash

openclaw install bookstack
    
Copied!

๐Ÿ’ปCode Examples

python3 scripts/bookstack.py create_page --book-id 1 --name "My Page" --markdown "# Title\n\nContent here..."

python3-scriptsbookstackpy-createpage---book-id-1---name-my-page---markdown--titlenncontent-here.txt
## All Commands

### Books

python3 scripts/bookstack.py create_shelf "Name" ["Desc"] # New shelf

python3-scriptsbookstackpy-createshelf-name-desc--new-shelf.txt
## Configuration

Set the following environment variables:
example.sh
# 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..."
example.sh
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>
example.sh
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>
example.sh
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>
example.sh
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
example.sh
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
example.sh
export BOOKSTACK_URL="https://your-bookstack.example.com"
export BOOKSTACK_TOKEN_ID="your-token-id"
export BOOKSTACK_TOKEN_SECRET="your-token-secret"

โš™๏ธConfiguration Options

Option Type Default Description
BOOKSTACK_URLstringhttps://your-bookstack.example.com-
BOOKSTACK_TOKEN_IDstringyour-token-id-
BOOKSTACK_TOKEN_SECRETstringyour-token-secret-

Tags

#notes_and-pkm #api #integration

Quick Info

Category File Management
Model Claude 3.5
Complexity One-Click
Author xenofex7
Last Updated 3/10/2026
๐Ÿš€
Optimized for
Claude 3.5
๐Ÿง 

Ready to Install?

Get started with this skill in seconds

openclaw install bookstack