docs-builder

Global Options

-l --log-level enum

Minimum log level.

Values: trace, debug, information, warning, error, critical, none

Default: information

-c --config-source enum

Override the configuration source: local, remote

Values: local, remote, embedded

--[no-]skip-private-repositories
Skip cloning private repositories

Commands

assemble

Clone all repositories and build the unified documentation site in one step.

build

Build a single documentation set from source.

diff

Verify every renamed or removed page in the current branch has a redirect entry.

format

Fix common formatting issues (irregular spacing, trailing whitespace) across documentation files.

index

Index a single documentation set into Elasticsearch.

mv

Move a file or folder and rewrite all inbound links across the documentation set.

serve

Serve a documentation folder at http://localhost:3000 with live reload.

Namespaces

assembler

Build a unified documentation site by composing multiple documentation sets under a shared navigation.

changelog

Create, bundle, and publish changelog entries.

codex

Build a documentation portal over multiple independent documentation sets, each with its own navigation.

inbound-links

Validate cross-doc-set links against the published link registry.

Previous
Elastic CLI
Next
assemble
  • View as Markdown
  • Edit this page
On this page
  • Global Options
  • Commands
  • Namespaces
  • docs-builder

  • Getting started
    • Installation
    • Serve & preview
    • Writing content
    • Pages & links
    • Publish
  • Syntax guide
    • Quick reference
    • How directives work
    • Headings
    • Admonitions
    • Agent skill
    • Applies to
    • Applies switch
    • Automated settings reference
    • Buttons
    • Card group
    • Changelog
    • Code
    • Comments
    • Contributors
    • CSV files
    • Dropdowns
    • Definition lists
    • Explore
    • File inclusion
    • Footnotes
    • Frontmatter
    • Get started
    • Hero
    • Hub pages
    • Icons
    • Images
    • Videos
    • Keyboard markup
    • Link card
    • Math
    • Mermaid diagrams
    • Lists
    • Task Lists
    • Line breaks
    • Storybook
    • Links
    • List sub-pages
    • Page cards
    • Stepper
    • Substitutions
    • Version Variables
    • Sundries
    • Tables
    • Tabs
    • Title
    • What's new
  • Examples
    • docs-builder documentation hub
  • Documentation Builds
    • Distributed
    • Cross-links
    • Isolated
      • Configuration
      • Navigation
      • URLs
      • CTA
      • Extensions
      • Move files and folders
    • Assembler
      • Configuration
      • Navigation
      • URLs
      • Environments
      • Add a new repo to the docs
      • Infrastructure
    • Codex
      • Configuration
      • Navigation
      • URLs
      • Infrastructure
    • Catalog Configuration
      • products.yml
      • versions.yml
      • search.yml
      • legacy-url-mappings.yml
    • Redirects
  • Structured Data
    • MCP server
    • REST API
    • OpenAPI
      • API Explorer
    • CLI Schema
      • Supplemental content
    • Exporters
      • Elasticsearch
      • LLM Markdown
      • OKF
      • Plain Text
    • Release notes
      • Create release notes from changelogs
        • Configure changelogs
          • Configuration reference
        • Create changelogs
        • Bundle changelogs
        • Publish changelogs
      • Release Notes Explorer
  • Elastic Integrations
    • GitHub
    • Elastic CLI
  • CLI Reference
    • assemble cmd
    • build cmd
    • diff cmd
    • format cmd
    • index cmd
    • mv cmd
    • serve cmd
    • assembler ns
      • ai-enrich cmd
      • build cmd
      • clone cmd
      • index cmd
      • serve cmd
      • sitemap cmd
      • bloom-filter ns
        • create cmd
        • lookup cmd
      • config ns
        • init cmd
      • content-source ns
        • match cmd
        • validate cmd
      • deploy ns
        • apply cmd
        • plan cmd
        • update-redirects cmd
      • navigation ns
        • validate cmd
        • validate-link-reference cmd
    • changelog ns
      • add cmd
      • bundle cmd
      • bundle-amend cmd
      • evaluate-artifact cmd
      • evaluate-pr cmd
      • gh-release cmd
      • init cmd
      • migrate-from-web cmd
      • prepare-artifact cmd
      • remove cmd
      • render cmd
      • scrubber-allowlist cmd
      • upload cmd
    • codex ns
      • build cmd
      • clone cmd
      • index cmd
      • serve cmd
      • update-redirects cmd
      • sync ns
        • apply cmd
        • plan cmd
    • inbound-links ns
      • validate cmd
      • validate-all cmd
      • validate-link-reference cmd
  • Development Notes
    • Navigation system
    • Elasticsearch Ingest
    • essc — sourcing CLI
    • Changelog bundle registry
    • Link validation
Elastic logo

© 2026 Elasticsearch B.V. All Rights Reserved.

  • Terms of Use
  • Privacy