seerbook-cli
v2.4.0
Published
CLI to generate books and documentation using seerbook
Downloads
4
Readme
seerbook-cli
The SeerBook command line interface.
Install this globally and you'll have access to the seerbook command anywhere on your system.
$ npm install -g seerbook-cli
Note: The purpose of the seerbook command is to load and run the version of SeerBook you have specified in your book (or the latest one), irrespective of its version. The GitBook CLI only support versions >=2.0.0
of GitBook.
seerbook-cli
store SeerBook's versions into ~/.seerbook
, you can set the SEERBOOK_DIR
environment variable to use another directory.
How to install it?
$ npm install -g seerbook-cli
How to use it?
Run SeerBook
Run command seerbook build
, seerbook serve
).
List all available commands using:
$ seerbook help
Specify a specific version
By default, SeerBook CLI will read the seerbook version to use from the book configuration, but you can force a specific version using --seerbook
option:
$ seerbook build ./mybook --seerbook=2.0.1
and list available commands in this version using:
$ seerbook help --seerbook=2.0.1
Manage versions
List installed versions:
$ seerbook ls
List available versions on NPM:
$ seerbook ls-remote
Install a specific version:
$ seerbook fetch 2.1.0
# or a pre-release
$ seerbook fetch beta
Update to the latest version
$ seerbook update
Uninstall a specific version
$ seerbook uninstall 2.0.1
Use a local folder as a SeerBook version (for developement)
$ seerbook alias ./myseerbook latest