Examples of BookStack API scripts

Find a file

Dan Brown 97f2da1f56 Added bsfs to community project list		2025-03-23 19:57:06 +00:00
.github	Create FUNDING.yml	2021-01-02 18:15:33 +00:00
chrome-extension-google-search-results	Added google search results chrome extension example	2022-05-09 18:08:36 +01:00
dotnet-upload-attachment	Added dotnet attachment upload example	2022-02-06 06:48:51 +00:00
go-export-page-content	Fixed go script path, added a little concurrency	2022-04-10 17:00:25 +01:00
node-docx-to-page	Added node docx-to-page example	2021-06-05 00:28:08 +01:00
node-generate-postman-collection	Added postman collection gen example	2022-02-10 12:53:25 +00:00
node-upload-attachment	Added node-based file attachment upload example	2022-02-05 06:35:15 +00:00
php-book-to-static-site	Made some fixes and added comments to static-site-gen	2021-01-03 18:53:45 +00:00
php-export-all-books	Updated php-export-all-books script	2023-09-09 12:26:22 +01:00
php-generate-sitemap	Fixed array concatenation in sitemap gen script	2021-11-09 14:36:46 +00:00
php-generate-tree	Added php-generate-tree script	2024-07-24 16:42:00 +01:00
powershell-files-to-pages	Updated powershell script readme	2023-03-01 22:54:30 +00:00
python-upload-attachment	Added python attachment upload example	2022-12-03 02:45:54 +00:00
rust-list-all-pages	Added rust-list-all-pages example	2022-06-02 16:12:24 +01:00
.gitignore	Added python attachment upload example	2022-12-03 02:45:54 +00:00
LICENSE	Initial commit	2021-01-02 18:14:50 +00:00
README.md	Added bsfs to community project list	2025-03-23 19:57:06 +00:00

README.md

BookStack API Scripts

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.

Contributing

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.

Community Projects & Scripts

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.

Yetangitu/bs [Bash]

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

coffeepenbit/bookstack [Python]

A Python wrapper for the BookStack API.

Szwendacz99/BookStack-Python-exporter [Python]

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

My-Random-Thoughts/psBookStack [PowerShell]

A PowerShell module for interacting with BookStack via the API.

chris-devel0per/FlutterBookstackApiExample [Flutter/Dart]

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

IceWreck/BookStack2Site [Go]

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

jaypyles/obisidan_to_bookstack [Python]

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

bookstack/filesystem [Go]

A BookStack filesystem implementation via FUSE using exports via the API.