npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

bookstack-cli

v1.0.1

Published

CLI for interacting with the BookStack API from your terminal.

Downloads

188

Readme

bookstack-cli

CLI for interacting with the BookStack API from your terminal.

Install globally and use the book-cli command:

npm install -g bookstack-cli

Requirements

  • Node.js 18+
  • A BookStack instance with API tokens

Command

book-cli <command> [options]

View help:

book-cli --help
book-cli <command> --help

Configuration

book-cli supports three credential sources, in this order (highest to lowest priority):

  1. Command flags
  2. .bsrc config file
  3. Environment variables

1) Initialize .bsrc config

Save config in current directory:

book-cli init \
  --apihost https://docs.example.com \
  --apitoken YOUR_TOKEN_ID \
  --apisecret YOUR_TOKEN_SECRET

Save config globally to ~/.bsrc:

book-cli init --global \
  --apihost https://docs.example.com \
  --apitoken YOUR_TOKEN_ID \
  --apisecret YOUR_TOKEN_SECRET

Example .bsrc file:

{
  "apiHost": "https://docs.example.com",
  "apiKey": "YOUR_TOKEN_ID",
  "apiSecret": "YOUR_TOKEN_SECRET"
}

2) Environment variables

export BOOKSTACK_API_HOST=https://docs.example.com
export BOOKSTACK_API_KEY=YOUR_TOKEN_ID
export BOOKSTACK_API_SECRET=YOUR_TOKEN_SECRET

Run API Methods

Syntax:

book-cli <resource> <method> [args...] [--apihost ... --apitoken ... --apisecret ...]

Legacy alias (still supported):

book-cli run <resource> <method> [args...]

Supported resources:

  • book / books
  • page / pages
  • chapter / chapters
  • shelf / shelves
  • user / users

Common methods:

  • list(params?)
  • create(data)
  • read(id)
  • update(id, data)
  • delete(id)

Examples

List books:

book-cli book list

List with query params:

book-cli books list '{"count":5,"sort":"-id"}'

Read page by id:

book-cli page read 15

Create chapter:

book-cli chapter create '{"book_id":5,"name":"CLI Chapter"}'

Update shelf:

book-cli shelf update 3 '{"name":"Updated Shelf"}'

Delete user:

book-cli user delete 12

Use per-command credential overrides:

book-cli book list \
  --apihost https://docs.example.com \
  --apitoken YOUR_TOKEN_ID \
  --apisecret YOUR_TOKEN_SECRET

Argument Parsing Rules

book-cli automatically parses arguments as:

  • Integer numbers (for example 15)
  • Booleans (true / false)
  • JSON objects/arrays ({"count":5} or [1,2,3])
  • Plain strings (everything else)

Output and Errors

  • Successful responses are printed as formatted JSON.
  • API or validation errors are printed to stderr and exit with code 1.

License

ISC