Docs Command¶

The docs command launches an interactive terminal-based documentation browser.

Usage¶

mytool docs [flags]

Description¶

Launches a TUI for browsing embedded project documentation. It features a split-pane layout, asynchronous background search, and an AI-powered Q&A assistant.

Flags¶

TUI Keybindings¶

Docs Serve Subcommand¶

The docs serve subcommand starts a local HTTP server to preview the documentation as a static site.

Usage:

mytool docs serve [flags]

Description: Start a local HTTP server and serve the documentation as a Material-styled static site. By default, it automatically opens the local URL in your default browser.

Flags: | Name | Description | Default | | :--- | :--- | :--- | | -p, --port | Port to listen on (0 for random) | 8080 | | --open | Automatically open the browser | true |

[!NOTE] The serve command is only available if the static site assets have been pre-built and embedded into the binary.

Docs Ask Subcommand¶

The docs ask subcommand allows you to query the documentation directly from the command line without launching the TUI.

Usage:

mytool docs ask "How do I configure logging?"

Aliases: ?

Description: Ask a question about the documentation and receive an AI-generated answer rendered in the terminal. This is useful for quick lookups or when running in non-interactive environments.

Flags:

Examples:

# Ask a question with styled output
mytool docs ask "What is the Props container?"

# Ask without markdown formatting (useful for piping)
mytool docs ask --no-style "List all available commands" | grep init

# Use a specific AI provider
mytool docs ask --provider claude "Explain the configuration system"

Implementation¶

The docs command is implemented in cmd/docs/docs.go and utilizes the pkg/docs library for TUI rendering and search.