SkillsAdd

gitbookio/skills · Archived

gitbook-cli

>- How to use the GitBook CLI (the `gitbook` command from the @gitbook/cli package) to authenticate, scaffold and develop GitBook integrations, publish and unpublish them, check the authenticated user, and publish or update OpenAPI specs to a GitBook organization (including from CI/CD). Use this skill whenever the user runs or asks about any `gitbook` subcommand (auth, new, dev, publish, unpublish, whoami, openapi publish), is building or shipping a GitBook integration, edits a gitbook-manifest…

First seen Jun 20, 2026

Installation

$ npx skills add gitbookio/skills --skill gitbook-cli
View on skills.sh ↗ GitHub repository ↗

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

gitbook-write Same source
gitbookio/skills

A comprehensive guide for editing GitBook documentation in external environments like Cursor, C…

3 installs
gitbook-site Same source
gitbookio/skills

Create and maintain entire GitBook documentation sites end-to-end — design the site structure f…

3 installs
gitbook-openapi Same source
gitbookio/skills

>- Author, configure, structure, and troubleshoot OpenAPI/Swagger API reference documentation i…

3 installs
gitbook Similar · more installs
membranedev/application-skills

GitBook integration. Manage data, records, and automate workflows. Use when the user wants to i…

76 installs

Also in this package

Other skills from gitbookio/skills.

npx skills add gitbookio/skills
gitbook-write 3 gitbook-site 3 gitbook-openapi 3

Browse all from gitbookio/skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

License LICENSE
Default branch main
Open issues 0
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 5,148 B
  • docs SUMMARY.md 619 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 3 installs

SKILL.md

GitBook CLI

The gitbook command (from the @gitbook/cli npm package) builds and publishes integrations on GitBook.com and publishes OpenAPI specs to a GitBook organization. This is the integration-platform CLI, not the legacy gitbook-cli book builder.

Setup

Install globally to get the gitbook command anywhere:

npm install -g @gitbook/cli

Or run it without installing:

npx @gitbook/cli <command>

Authenticate before running any command that talks to GitBook (everything except help). Without a valid session, those commands will fail.

gitbook auth            # prompts for a token
gitbook auth --token=<token>   # non-interactive, use this in CI
gitbook whoami          # confirm the session and which account is active

Choosing the right command

Goal Command
Authenticate / log in gitbook auth
Check who is logged in gitbook whoami
Start a new integration gitbook new <dir>
Develop with a live link to the editor gitbook dev
Publish an integration gitbook publish
Remove a published integration gitbook unpublish <integration-name>
Publish or update an OpenAPI spec gitbook openapi publish <spec.yaml> --spec <name> --organization <org-id>
List all commands gitbook help

Integration workflow

The common path for building and shipping an integration:

  1. gitbook new <dir> to scaffold the integration locally.
  2. gitbook dev to connect it to your GitBook editor and iterate with live updates.
  3. gitbook publish to ship it (reads gitbook-manifest.yaml).
  4. gitbook unpublish <integration-name> if you need to take it down.

Command reference

gitbook auth

Authenticate the CLI with a GitBook Developer API token. Generate a personal token in your GitBook Developer settings. Pass it non-interactively with --token=<token> (do this in CI so nothing is prompted); if no token is provided, the CLI prompts for one.

gitbook whoami

Print information about the currently authenticated user. Use it to confirm authentication succeeded or to check which account is active.

gitbook new <dir>

Create and initialize a new integration locally in <dir>. The CLI prompts for information about the integration.

gitbook dev

Open a live connection from your local integration to your GitBook editor. While the connection is running, changes you make locally are received in the editor automatically. See the development guide.

gitbook publish

Publish the integration defined in the gitbook-manifest.yaml file. See the GitBook Manifest reference for the manifest fields, and the publishing guide for how publishing works.

gitbook unpublish <integration-name>

Remove your integration from the GitBook integration platform. Pass the name of the integration as the argument.

gitbook openapi publish

gitbook openapi publish <path_to_spec.yaml> --spec <spec_name> --organization <organization_id>

Publish a new OpenAPI spec or update an existing one in your organization. Re-running the command with the same --spec name updates that spec in place, which is what makes it safe to run on every commit in a CI/CD pipeline. See the CI/CD with API blocks guide to learn more about documenting your API in GitBook.

Argument Description
<pathtospec.yaml> Path to the local OpenAPI specification file to publish.
--spec <spec_name> Name/slug of the spec in your organization. Reuse the same name to update an existing spec.
--organization <organization_id> The GitBook organization the spec belongs to.

gitbook help

List the available GitBook CLI commands and information on using them.

Notes

  • Run gitbook auth (or pass --token) before new, dev, publish, unpublish, or openapi publish. Only help works without a session.
  • In CI, prefer gitbook auth --token=$GITBOOK_TOKEN with the token stored as a secret, so no step blocks on an interactive prompt.
  • publish always reads gitbook-manifest.yaml from the integration directory, so keep that file in sync with what you intend to ship.