Command reference

Overview

DocuBot is primarily managed through its web dashboard. While the system handles complex documentation generation and synchronization, you interact with these processes using the interface rather than a terminal. These dashboard actions allow you to manage documentation synchronization and project configuration.

Command-line interface

A public command-line interface (CLI) isn’t available in the current version of DocuBot. You can’t trigger syncs or modify project settings via a terminal or shell environment. All interactions occur within the DocuBot dashboard at docubot.cc.

Core actions

The following actions in the dashboard perform the primary functions for documentation management:

Manual sync

You can trigger an immediate update of your documentation by selecting the Rebuild documentation or Sync button on your repository card. This bypasses the daily schedule and enqueues a new sync job.

Build status

You can check the status of a documentation build by viewing the repository card on your dashboard. It displays the current status (e.g., Queued, Syncing, Up to date) and shows progress for active jobs.

PDF export

DocuBot automatically generates a PDF version of your documentation during the sync process. You can access this by clicking the Download PDF link on your repository card.

Configuration actions

You can modify your project’s scope and behavior through the Edit settings page. This includes the following configuration options:

URL slug

You can