Skip to content
DocuBot documentation

Command reference

Overview

DocuBot operates primarily through a web-based dashboard. You manage your documentation sites, repository sources, and synchronization triggers through the user interface rather than a local command-line environment. The system handles the heavy lifting of code analysis and static site generation on secure, remote workers.

Command Line Interface

A public Command Line Interface (CLI) for external developers or administrators is not available at this time. All configuration, including audience selection, document type refinement, and style application, is performed within the DocuBot workspace.

If you require programmatic access or have specific integration needs, please contact our support team at support@ademero.com or visit https://www.ademero.com.

Manual sync actions

While DocuBot is designed to be automated, you can trigger immediate “command-like” actions from the repository list to refresh your documentation on demand.

Rebuild documentation

This action instructs the DocuBot engine to immediately pull the latest state from your connected GitHub repositories and regenerate the entire documentation set.

  • Usage: Click the Rebuild documentation button on any active repository card.
  • Daily Limit: Manual syncs are limited to 500 requests per day per repository.
  • Outcome: The system queues a new sync job. You can monitor the progress (Planning, Writing, Building, and Uploading) directly on the repository card.

Automated sync scheduling

You “command” the system’s automated behavior by configuring the sync schedule. These settings determine when the backend engine executes the documentation update sequence.

ParameterDescription
FrequencyChoose between Daily, Weekly, or Monthly updates.
Update TimeThe specific time of day (HH:MM) the sync command triggers.
Time ZoneThe local time zone used to calculate the update time.
WeekdayFor weekly schedules, the specific day the sync runs.
Day of MonthFor monthly schedules, the specific calendar day the sync runs.

Support and assistance

If you encounter issues with manual triggers or automated scheduling, you can reach out for help through the following channels: