cli

package
v0.7.1 Latest Latest
Warning

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

Go to latest
Published: Feb 15, 2026 License: MIT Imports: 44 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Version = "dev"
	Commit  = "none"
	Date    = "unknown"
)
View Source
var RootCmd = &cobra.Command{
	Use:           "roady",
	Version:       Version,
	SilenceErrors: true,
	SilenceUsage:  true,
	Short:         "A planning-first system of record for software work",
	Long: `Roady is a planning-first system of record for software work.
It helps individuals and teams answer:
1. What are we building?
2. Why are we building it?
3. What should happen next?`,
}

RootCmd represents the base command when called without any subcommands

View Source
var RunForecast = runForecast

RunForecast is the exported RunE function for use as a subcommand

View Source
var RunTimeline = runTimeline

RunTimeline is the exported RunE function for use as a subcommand

View Source
var RunUsage = runUsage

RunUsage is the exported RunE function for use as a subcommand

Functions

func Execute

func Execute() error

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the RootCmd.

func MapError added in v0.6.0

func MapError(err error) error

MapError converts known domain errors into CLIErrors with actionable hints. Unmapped errors are returned as-is.

Types

type CLIError added in v0.6.0

type CLIError struct {
	Message  string
	Hint     string
	Err      error
	ExitCode int
}

CLIError wraps domain errors with user-facing messages and actionable hints.

func NewCLIError added in v0.6.0

func NewCLIError(msg, hint string, err error) *CLIError

NewCLIError creates a CLIError with a default exit code of 1.

func (*CLIError) Error added in v0.6.0

func (e *CLIError) Error() string

func (*CLIError) Unwrap added in v0.6.0

func (e *CLIError) Unwrap() error

type PluginInfo added in v0.4.0

type PluginInfo struct {
	Name        string
	Description string
	ConfigKeys  []string
	GoPackage   string // for go install
}

PluginInfo describes an available plugin

Jump to

Keyboard shortcuts

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