bookstack

The BookStack API Skill provides a robust interface for interacting with your BookStack documentation instance. Designed for technical writers, knowledge managers, and developers, this tool bridges the gap between local development environments and your centralized wiki. It allows for seamless automation of documentation workflows, ensuring that your knowledge base stays synchronized with code changes, deployment logs, or project updates without manual browser intervention. Users can programmatically create, read, update, and delete (CRUD) books, chapters, and pages, making it ideal for maintaining technical documentation, internal wikis, or project knowledge bases efficiently.

• Full support for REST API interactions including page retrieval, HTML/Markdown content updates, and organizational management of shelves and books.

• Integrated full-text search capability to quickly locate documentation across large instances.

• Support for both HTML and Markdown content formats, enabling flexible content creation and updates.

• Seamless automation for syncing external documentation workflows or bulk importing content into the knowledge base.

• Security-conscious design utilizing local configuration files for API credentials, keeping sensitive tokens out of source code.

• Ensure the 'Access System API' permission is enabled for your user role in BookStack settings before attempting authentication.

• Always include a proper User-Agent header in requests, especially when operating behind Cloudflare, to avoid 403 Forbidden errors.

• For large-scale updates, it is recommended to store content in temporary files and pass them to the script, preventing command-line argument limits or escaping issues.

• The script handles content format conversion automatically; use the --markdown flag for input or retrieval as needed.

• Credentials should be securely stored in the ~/.clawdbot/clawdbot.json configuration file to maintain portability and security across different environments.