Archbee CLI Command Examples

This guide shows common Archbee CLI workflows with practical command examples.

Most local development commands can run without authentication. Commands that interact with content on the Archbee platform usually require both an API key and a space ID.

Use these commands while writing or testing documentation locally.

Preview your docs with live reload during development:

Example output:

The local site typically runs on:

Validate your documentation structure and configuration:

Example output:

This command helps detect missing config files, invalid structures, and other common setup issues.

Check for broken internal links:

Example output:

This is useful before publishing changes.

Most document management commands require:

Search for documents inside a documentation space:

Example output:

Retrieve a document by ID:

Example output:

The --format flag supports formats such as markdown, html, json, and source.

Create a new document or update an existing one from a local markdown file:

Example output:

Delete a document from a space:

Example output:

Use delete commands carefully because they directly affect published documentation.

The Archbee CLI can import and synchronize OpenAPI specifications to generate API reference documentation.

Sync an OpenAPI file into a documentation space:

Example output:

Retrieve information about an existing OpenAPI documentation tree:

Example output:

If synchronization fails, validate the OpenAPI schema before retrying.

The CLI can also manage uploaded files directly from the terminal.

Upload a file:

Example output:

List uploaded files and folders:

Example output:

Replace an existing file while keeping the same public URL:

Example output:

Publish documentation updates to production:

Example output:

Make sure the API key has write permissions before publishing.

Every CLI command supports the --help flag.

Example:

Example output:

This displays all supported flags, arguments, and usage examples for the selected command.