suggest

package

v0.30.0 Latest Latest Go to latest Published: Feb 6, 2026 License: MIT Imports: 1 Imported by: 0

Details

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

Repository

github.com/marcus/td

Links

Open Source Insights

Documentation ¶

Overview ¶

Package suggest provides fuzzy matching for CLI flag and command suggestions using Levenshtein distance.

Index ¶

Variables
func Flag(unknown string, validFlags []string) []string
func GetFlagHint(flag string) string

Constants ¶

This section is empty.

Variables ¶

View Source

var CommonFlagAliases = map[string]string{

	"note":  "--description, -d",
	"notes": "--description, -d",
	"msg":   "--description, -d",

	"comment":  "--reason, -m",
	"comments": "--reason, -m",
	"message":  "--reason, -m",

	"id":       "--issue",
	"issue-id": "--issue",
	"task":     "--issue",

	"force":   "(not supported - use confirmation prompt)",
	"confirm": "(not supported - use confirmation prompt)",
	"yes":     "(not supported - use confirmation prompt)",
	"y":       "(not supported - use confirmation prompt)",

	"version": "use: td version",
	"v":       "use: td version",

	"state": "--status, -s",

	"review": "use: td review <issue-id> (after td handoff)",
}

CommonFlagAliases maps commonly attempted flags to their correct names

Functions ¶

func Flag ¶

func Flag(unknown string, validFlags []string) []string

Flag finds similar flags from a list of valid flags Returns suggestions sorted by similarity (best first)

func GetFlagHint ¶

func GetFlagHint(flag string) string

GetFlagHint returns a hint for a commonly misused flag

Types ¶

This section is empty.

Source Files ¶

View all Source files

suggest.go

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