Installation

Setting up DocuBook is straightforward, with options to clone the repository or use the convenient npx command. DocuBook requires Node.js version 18 or higher for optimal performance.

Quick Setup with CLI

For a faster setup, use the cli command to create a new DocuBook project in one step:

npx @docubook/cli@latest

Installing the CLI Globally

If you prefer installing the CLI globally so the docubook command is available system-wide, use one of the following:

npm install -g @docubook/cli@latest

After a global install, verify the installation and check the CLI version:

# init
docubook

# with argumen [projectname]
docubook my-project

# show version
docubook version

# update
docubook update

If you used npx, pnpm dlx, bunx or yarn dlx you can still run the CLI directly without installing. Example:

npx @docubook/cli@latest --version

These commands install the docubook binary (package "bin"), so the docubook command should be available in your PATH after installation.

With this setup, you’ll have a ready-to-use DocuBook instance to start building your documentation.