DocsHub CLI

Simplify your workspace setup, Docker configuration, and content creation with a single command.

2024-09-04
3 min read
Roberto

DocsHub CLI is your all-in-one assistant for initializing DocsHub, creating new documentation, launching the application, and everything you need to build amazing documentation 📚.

Docshub CLI Screenshot

Run CLI

npx docshub

When we run the command without any arguments, we get a command-line interface with a set of options and functionalities that we can execute.

New workspace

You can use the CLI to initialize the workspace in two ways:

  1. By running npx docshub and selecting “Initialize workspace”.
  2. Or by running npx docshub init directly.

Regardless of the option you choose, the CLI will generate a directory and file structure in your project, including the following elements:

.
├── 📂 docs/
   └── 📄 getting-started.mdx
├── 📂 images/
├── 📄 docker-compose.yml
└── 📄 .env

Now that we have the /docs and /images directories, the docker-compose.yml file, the getting-started.mdx template, and the default .env file generated. How can we start our application to edit the documentation or deploy it to production? For more details, please refer to the docker documentation:

This docker-compose.yml file documents the execution modes of DocsHub, which you can explore in more detail in the specific docker documentation:

Docker How to run DocsHub using docker
Getting Started
2024-09-04

Additionally, you can learn about the parameters and configuration accepted by the generated .env file through its documentation.

Environment File Prepare your documentation site using custom environments
Configuration
2024-09-04

Create new document

To generate new .mdx documents inside the /docs folder, you can use the CLI in two ways:

  1. Run npx docshub, select “Create new document”, and fill in all the fields.
  2. Or run npx docshub create directly, and fill in all the fields.

This functionality generates a new document with the parameters entered in the header. However, to see which parameters are available, refer to the following documentation:

Create documentation How to create new documentation file
Write Docs
2024-09-04

Alternatively, if you want to explore the components and features available for use in your documents, you can refer to the relevant documentation:

UI Components Below you will find examples of all the formats you can use in your Markdown documentation
Components
2024-10-03
Mermaid Diagrams How to create diagrams and visualizations using Mermaid.js
Components
2024-10-03

Run interactive mode

This option allows you to run the DocsHub application in interactive mode or edit mode. It sets up a containerized development environment with zero configuration (with docker), enabling you to edit and view changes in your documentation. You can perform this action in two ways:

  1. You can do this either by running npx docshub and selecting the “Run interactive mode” option.
  2. Or by directly executing npx docshub interactive.

The application should be available at http://localhost:4321.

Run standard mode

This option allows you to run the DocsHub application in standard mode or production. This will start your site in production mode with the content you have previously edited. You can perform this action in two ways:

  1. You can do this either by running npx docshub and selecting the “Run standard mode” option.
  2. Or by directly executing npx docshub standard.

The application should be available at http://localhost:4321.

About and Help

  • The About option can be accessed by running npx docshub and selecting the “About” option, or by executing npx docshub about directly. This option provides detailed information about the version of the CLI you are currently running, including key features and version details.

  • The Help option is available by running npx docshub and selecting the “Need help?” option, or by executing npx docshub help directly. This option provides you with information about the available commands and their usage within the CLI, helping you understand how to interact with the tool.

License