help

package
v6.4.2 Latest Latest
Warning

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

Go to latest
Published: Nov 17, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package help implements the `stroppy help <topic>` subcommand.

Index

Constants

This section is empty.

Variables

View Source
var Cmd = NewCommand()

Cmd is the cobra command for `stroppy help [topic]`.

Functions

func NewCommand

func NewCommand() *cobra.Command

NewCommand creates an independent help command.

func Register

func Register(t Topic)

Register adds a topic to the help registry. Call this from init() functions in topic files.

Types

type Topic

type Topic struct {
	Name  string
	Short string
	Long  string
}

Topic is a help topic with a name, short description, and long content.

Jump to

Keyboard shortcuts

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