{"id":19501107,"url":"https://github.com/gitbookio/gitbook-cli","last_synced_at":"2025-05-14T13:05:50.254Z","repository":{"id":26229835,"uuid":"29676555","full_name":"GitbookIO/gitbook-cli","owner":"GitbookIO","description":"GitBook's command line interface","archived":false,"fork":false,"pushed_at":"2024-06-05T04:28:15.000Z","size":85,"stargazers_count":727,"open_issues_count":85,"forks_count":214,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-12T08:41:08.947Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GitbookIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-01-22T11:56:39.000Z","updated_at":"2025-05-09T03:55:27.000Z","dependencies_parsed_at":"2024-09-16T08:54:16.719Z","dependency_job_id":null,"html_url":"https://github.com/GitbookIO/gitbook-cli","commit_stats":{"total_commits":106,"total_committers":12,"mean_commits":8.833333333333334,"dds":"0.16981132075471694","last_synced_commit":"d36a41e1c4fe1e68fec2a4a404396d84fec766a4"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fgitbook-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fgitbook-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fgitbook-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fgitbook-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GitbookIO","download_url":"https://codeload.github.com/GitbookIO/gitbook-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254149949,"owners_count":22022851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T22:11:13.037Z","updated_at":"2025-05-14T13:05:50.193Z","avatar_url":"https://github.com/GitbookIO.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e ## ⚠️ Deprecation warning:\n\u003e\n\u003e 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.  \n\u003e All content supported by the CLI are mostly supported by our [GitBook.com / GitHub integration](https://docs.gitbook.com/getting-started/git-sync).\n\u003e\n\u003e Content hosted on the [legacy.gitbook.com](https://legacy.gitbook.com) will continue working until further notice. For differences with the new version, \u003e check out our [documentation](https://docs.gitbook.com/v2-changes/important-differences).\n\u003e\n\u003e Join our [GitHub community](https://github.com/GitbookIO/community) to stay up to date with the latest news at GitBook.\n\n# gitbook-cli\n\n[![NPM version](https://badge.fury.io/js/gitbook-cli.svg)](http://badge.fury.io/js/gitbook-cli)\n[![Linux Build Status](https://travis-ci.org/GitbookIO/gitbook-cli.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook-cli)\n[![Windows Build status](https://ci.appveyor.com/api/projects/status/gddbj0602joc4wah?svg=true)](https://ci.appveyor.com/project/GitBook/gitbook-cli)\n\n\u003e The GitBook command line interface.\n\nInstall this globally and you'll have access to the gitbook command anywhere on your system.\n\n```\n$ npm install -g gitbook-cli\n```\n\n**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 `\u003e=2.0.0` of GitBook.\n\n`gitbook-cli` store GitBook's versions into `~/.gitbook`, you can set the `GITBOOK_DIR` environment variable to use another directory.\n\n## How to install it?\n\n```\n$ npm install -g gitbook-cli\n```\n\n## How to use it?\n\n### Run GitBook\n\nRun command `gitbook build`, `gitbook serve` (read [GitBook documentation](https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md) for details).\n\nList all available commands using:\n\n```\n$ gitbook help\n```\n\n#### Specify a specific version\n\nBy default, GitBook CLI will read the gitbook version to use from the book configuration, but you can force a specific version using `--gitbook` option:\n\n```\n$ gitbook build ./mybook --gitbook=2.0.1\n```\n\nand list available commands in this version using:\n\n```\n$ gitbook help --gitbook=2.0.1\n```\n\n#### Manage versions\n\nList installed versions:\n\n```\n$ gitbook ls\n```\n\nList available versions on NPM:\n\n```\n$ gitbook ls-remote\n```\n\nInstall a specific version:\n\n```\n$ gitbook fetch 2.1.0\n\n# or a pre-release\n\n$ gitbook fetch beta\n```\n\nUpdate to the latest version\n\n```\n$ gitbook update\n```\n\nUninstall a specific version\n\n```\n$ gitbook uninstall 2.0.1\n```\n\nUse a local folder as a GitBook version (for developement)\n\n```\n$ gitbook alias ./mygitbook latest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbookio%2Fgitbook-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitbookio%2Fgitbook-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbookio%2Fgitbook-cli/lists"}