help

package

v1.4.5 Latest Latest Go to latest Published: Mar 22, 2026 License: MIT Imports: 4 Imported by: 0

Details

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

Repository

codeberg.org/dickus/dreadnotes

Links

Open Source Insights

Documentation ¶

Overview ¶

Package help provides usage instructions and help messages for the CLI application. It utilizes text/tabwriter to align command descriptions and flags neatly.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DoctorHelp ¶

func DoctorHelp()

DoctorHelp displays usage for 'doctor' command.

func Long ¶

func Long()

Long prints the full help message (root command).

func NewNoteHelp ¶

func NewNoteHelp()

NewNoteHelp displays usage for 'new' command.

func OpenNoteHelp ¶

func OpenNoteHelp()

OpenNoteHelp displays usage for 'open' command.

func RandomNoteHelp ¶

func RandomNoteHelp()

RandomNoteHelp displays usage for 'random' command.

func Short ¶

func Short()

Short prints a concise summary of available commands.

func SyncHelp ¶

func SyncHelp()

SyncHelp displays usage for 'sync' command.

Types ¶

type HelpData ¶

type HelpData struct {
	Title       string
	Description string
	Usage       string
	Flags       [][2]string // Each element is {flag, description}
	Examples    []string
}

HelpData holds the information required to print a standardized help message.

Source Files ¶

View all Source files

help.go

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