cli

package

v1.0.0 Latest Latest Go to latest Published: Apr 17, 2026 License: MIT Imports: 6 Imported by: 0

Details

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

Repository

github.com/0xble/ferry

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func EncodeJSON(w io.Writer, v any) error
func IsTerminal() bool
func WriteError(w io.Writer, format Format, e *CLIError)
type CLIError
- func Err(code, message string) *CLIError
- func ErrWithExit(code, message string, exitCode int) *CLIError
- func (e *CLIError) Error() string
type Format
- func ResolveFormat(flag string, jsonFlag bool) Format

Constants ¶

View Source

const (
	ExitOK       = 0
	ExitError    = 1
	ExitUsage    = 2
	ExitNotFound = 3
)

Variables ¶

This section is empty.

Functions ¶

func EncodeJSON ¶

func EncodeJSON(w io.Writer, v any) error

func IsTerminal ¶

func IsTerminal() bool

func WriteError ¶

func WriteError(w io.Writer, format Format, e *CLIError)

Types ¶

type CLIError ¶

type CLIError struct {
	Code        string   `json:"code"`
	Message     string   `json:"message"`
	Suggestions []string `json:"suggestions,omitempty"`
	ExitCode    int      `json:"exit_code"`
	Retryable   bool     `json:"retryable,omitempty"`
}

func Err ¶

func Err(code, message string) *CLIError

func ErrWithExit ¶

func ErrWithExit(code, message string, exitCode int) *CLIError

func (*CLIError) Error ¶

func (e *CLIError) Error() string

type Format ¶

type Format string

const (
	FormatTable Format = "table"
	FormatJSON  Format = "json"
)

func ResolveFormat ¶

func ResolveFormat(flag string, jsonFlag bool) Format

Source Files ¶

View all Source files

output.go

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