This repository contains different examples of BookStack API scripts that you might find useful to use or modify.

Each folder within this repo is a different script. Each script has it's own readme. Click into a folder to see the readme for detail about the script.

These scripts are not part an officially supported part of the BookStack project itself and therefore may be outdated or more likely to have bugs.

This repository is only meant to provide starting-off points as examples. Feel free to contribute fixes for existing scripts where needed, but we're relatively strict about keeping scope limited to ease maintenance so we're not looking to expand features of the scripts directly contained in this repository. If you build upon a script and want to share that back, feel free to open a PR to add it to the "Community Projects & Scripts" section below. We may be open to new scripts but only where the scope is fixed & narrow, and where there's value in something new it's demonstrating, otherwise PRs may be rejected. If you're unsure feel free to open an issue first to query a new addition before spending time on building out a script.

Here we showcase the awesome projects and scripts built by members of the community. These may reflect more full-featured examples of API use, or may provide a more complete basis for your own work.

If you've created something Open Source, which is using the BookStack API, feel free to open a pull request to add your project to this list.

A bash-based CLI for interacting with BookStack via the API.

A Python wrapper for the BookStack API.

A customizable Python script for exporting notes from BookStack through API.

A PowerShell module for interacting with BookStack via the API.

A Flutter & Dart example project which showcases the use of many BookStack API endpoints.

CLI tool which generates static sites (using Mdbook) from Bookstack Wikis.

CLI tool to update and sync a Bookstack instance with an Obsidian Vault