gitbook-cli is a command-line interface tool designed to manage and execute local installations of the open-source GitBook static site generator. It enables users to build, serve, and manage various versions of the GitBook engine (specifically GitBook versions >=2.0.0), storing them in a dedicated directory (defaulting to `~/.gitbook`). The current stable version indicated is 2.3.2. This toolchain facilitated local documentation and book generation, abstracting away direct `gitbook` engine installations. However, the GitBook project has since pivoted to a SaaS-first platform, and this open-source CLI and its associated engine are no longer actively maintained, making it an abandoned project. Its primary differentiator was simplifying local GitBook engine management and execution.
npm install gitbook-cliNo compatibility data collected yet for this library.
Installs the GitBook CLI globally, initializes a new book, builds and serves it, and demonstrates version management.
Consider migrating documentation to the modern GitBook platform (GitBook.com) or an alternative static site generator like Docsify, VuePress, Docusaurus, or MkDocs if a self-hosted solution is required.
Ensure that the GitBook version specified in your `book.json` (or via `--gitbook` option) is 2.0.0 or higher. Use `gitbook fetch <version>` to install compatible versions.
If encountering issues, try running `gitbook-cli` with an older, compatible Node.js version (e.g., Node.js 10 or 12) using a tool like `nvm` (Node Version Manager).
Run `npm install -g gitbook-cli` to install it globally. If the issue persists, ensure your shell's PATH includes `$(npm config get prefix)/bin`.
Update your `book.json` to specify a GitBook version like `"gitbook": ">=3.0.0"` or explicitly fetch and use a newer version with `gitbook fetch 3.2.3` and then `gitbook build --gitbook=3.2.3`.
Downgrade your Node.js version to an older LTS release, such as Node.js 12 or 14, using a Node.js version manager (e.g., `nvm install 14 && nvm use 14`).
No dependency data recorded yet.