Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GitbookIO/gitbook-cli
GitBook's command line interface
https://github.com/GitbookIO/gitbook-cli
Last synced: 3 months ago
JSON representation
GitBook's command line interface
- Host: GitHub
- URL: https://github.com/GitbookIO/gitbook-cli
- Owner: GitbookIO
- Created: 2015-01-22T11:56:39.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-05T04:28:15.000Z (5 months ago)
- Last Synced: 2024-07-19T10:58:22.642Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 83 KB
- Stars: 712
- Watchers: 15
- Forks: 217
- Open Issues: 87
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> ## ⚠️ Deprecation warning:
>
> As the efforts of the GitBook team are focused on the [GitBook.com](https://www.gitbook.com) platform, the CLI is no longer under active development.
> All content supported by the CLI are mostly supported by our [GitBook.com / GitHub integration](https://docs.gitbook.com/getting-started/git-sync).
>
> Content hosted on the [legacy.gitbook.com](https://legacy.gitbook.com) will continue working until further notice. For differences with the new version, > check out our [documentation](https://docs.gitbook.com/v2-changes/important-differences).
>
> Join our [GitHub community](https://github.com/GitbookIO/community) to stay up to date with the latest news at GitBook.
# gitbook-cli
[](http://badge.fury.io/js/gitbook-cli)
[](https://travis-ci.org/GitbookIO/gitbook-cli)
[](https://ci.appveyor.com/project/GitBook/gitbook-cli)
> The GitBook command line interface.
Install this globally and you'll have access to the gitbook command anywhere on your system.
```
$ npm install -g gitbook-cli
```
**Note:** The purpose of the gitbook command is to load and run the version of GitBook 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.
`gitbook-cli` store GitBook's versions into `~/.gitbook`, you can set the `GITBOOK_DIR` environment variable to use another directory.
## How to install it?
```
$ npm install -g gitbook-cli
```
## How to use it?
### Run GitBook
Run command `gitbook build`, `gitbook serve` (read [GitBook documentation](https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md) for details).
List all available commands using:
```
$ gitbook help
```
#### Specify a specific version
By default, GitBook CLI will read the gitbook version to use from the book configuration, but you can force a specific version using `--gitbook` option:
```
$ gitbook build ./mybook --gitbook=2.0.1
```
and list available commands in this version using:
```
$ gitbook help --gitbook=2.0.1
```
#### Manage versions
List installed versions:
```
$ gitbook ls
```
List available versions on NPM:
```
$ gitbook ls-remote
```
Install a specific version:
```
$ gitbook fetch 2.1.0
# or a pre-release
$ gitbook fetch beta
```
Update to the latest version
```
$ gitbook update
```
Uninstall a specific version
```
$ gitbook uninstall 2.0.1
```
Use a local folder as a GitBook version (for developement)
```
$ gitbook alias ./mygitbook latest
```