desc

package

v0.8.0 Latest Latest Go to latest Published: Mar 24, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Details

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

Repository

github.com/ActiveMemory/ctx

Links

Open Source Insights

Documentation ¶

Overview ¶

Package desc provides command, flag, text, and example description lookups backed by embedded YAML.

Index ¶

func Command(key string) (short, long string)
func Example(name string) string
func Flag(name string) string
func Text(name string) string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Command ¶

func Command(key string) (short, long string)

Command returns the Short and Long descriptions for a command.

Keys use dot notation: "pad", "pad.show", "system.bootstrap". Returns empty strings if the key is not found.

Parameters:

key: Command key in dot notation

Returns:

short: One-line description
long: Multi-line help text (may be empty)

func Example ¶

func Example(name string) string

Example returns example usage text for a given key.

Keys match entry types: "decision", "learning", "task", "convention". Returns an empty string if the key is not found.

Parameters:

name: Entry type key

Returns:

string: Example text

func Flag ¶

func Flag(name string) string

Flag returns the description for a flag.

Keys use dot notation: "add.file", "context-dir". Returns an empty string if the key is not found.

Parameters:

name: Flag key in dot notation

Returns:

string: Flag description

func Text ¶

func Text(name string) string

Text returns a user-facing text string by key.

Keys use dot notation: "agent.instruction", "backup.run-hint". Returns an empty string if the key is not found.

Parameters:

name: Text key in dot notation

Returns:

string: Text content

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