docs

package

v0.49.0 Latest Latest Go to latest Published: Oct 25, 2026 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitlab.com/phpboyscout/go-tool-base

Links

Open Source Insights

README ¶

Docs Command

Launches an interactive terminal-based documentation browser.

For detailed information on usage, keybindings, and implementation, see the Built-in Commands Documentation.

Documentation ¶

Overview ¶

Package docs provides the Cobra `docs` command for browsing this tool's embedded documentation in a terminal (an interactive Bubble Tea browser), with two subcommands: `serve` (host the docs as a static HTTP site) and `ask` (AI-assisted Q&A grounded in the bundled docs at runtime).

Index ¶

func NewCmdDocs(p *props.Props) *setup.Command
func NewCmdDocsAsk(p *props.Props) *cobra.Command
func NewCmdDocsServe(_ *props.Props, efs fs.FS) *cobra.Command

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewCmdDocs ¶

func NewCmdDocs(p *props.Props) *setup.Command

NewCmdDocs creates the docs command with the interactive documentation browser.

func NewCmdDocsAsk ¶

func NewCmdDocsAsk(p *props.Props) *cobra.Command

NewCmdDocsAsk creates the docs ask subcommand for AI-powered documentation Q&A.

func NewCmdDocsServe ¶

func NewCmdDocsServe(_ *props.Props, efs fs.FS) *cobra.Command

NewCmdDocsServe creates the docs serve subcommand for local documentation hosting.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL