CLI Installation

The Hyperdocs CLI is the easiest way to manage, sync, and deploy your documentation sites directly from your local terminal or within CI/CD pipelines.

Before installing the CLI, ensure you have Node.js version 18.0.0 or higher installed on your machine.

How to Install

You can install the CLI globally on your system using your preferred package manager:

Package Manager	Installation Command
npm	npm install -g @hyperdocs/cli
yarn	yarn global add @hyperdocs/cli
pnpm	pnpm add -g @hyperdocs/cli

Verification

To verify that the installation was successful, run the following command to check the installed version:

bash

hyperdocs --version

You can run "hyperdocs --help" or append "--help" to any command to see detailed usage information.