help

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	GROUP_AUTH = &cobra.Group{
		ID:    "auth",
		Title: style.Heading("Authentication Commands"),
	}
	GROUP_ADMIN = &cobra.Group{
		ID:    "admin",
		Title: style.Heading("Admin Management Commands"),
	}
	GROUP_API_KEYS = &cobra.Group{
		ID:    "api-keys",
		Title: style.Heading("API Key Management Commands"),
	}
	GROUP_PROJECTS = &cobra.Group{
		ID:    "projects",
		Title: style.Heading("Project Management Commands"),
	}
	GROUP_ORGANIZATIONS = &cobra.Group{
		ID:    "organizations",
		Title: style.Heading("Organization Management Commands "),
	}
	GROUP_VECTORDB = &cobra.Group{
		ID:    "vectordb",
		Title: style.Heading("Vector Database Commands"),
	}
	GROUP_INDEX_DATA = &cobra.Group{
		ID:    "index-data",
		Title: style.Heading("Index Data Commands"),
	}
	GROUP_INDEX_NAMESPACE = &cobra.Group{
		ID:    "index-namespace",
		Title: style.Heading("Index Namespace Commands"),
	}
)
View Source
var HelpTemplate = description +
	usage +
	aliasesAndExamples +
	noGroupCmds +
	groupCmds +
	additionalCmds +
	flagsAndFooter

Functions

func EnableHelpRendering added in v0.0.59

func EnableHelpRendering(root *cobra.Command)

func Examples

func Examples(examples string) string
Normalizes a Cobra Example block

- Accepts a multi-line string with possible indentation - De-indents with heredoc.Doc, trims leading/trailing whitespace, preserves interior blank lines - Left-indents each line and adds $ for command lines

func Long added in v0.0.59

func Long(longDesc string) string

Normalizes a Cobra Long block

func LongF added in v0.0.59

func LongF(longDesc string, args ...any) string

Normalizes a Cobra Long block with variadic args for formatting

Types

This section is empty.

Jump to

Keyboard shortcuts

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