cli

package

Go to main page

Versions in this module

v0

v0.10.6

Jul 8, 2026

Changes in this version

+ var ClassifyUntypedProbe func(error)

+ func AggregateCode(top Error) errtax.Code

+ func WriteEnvelopeDocument(w io.Writer, doc any) error

type CLIInputKind

+ const InputForceRequired

+ const InputIssueTypeUnknown

+ const InputSavedQueryUnknown

+ type CodedError struct

+ func NewCodedError(code errtax.Code, msg string) *CodedError

+ func WrapCoded(code errtax.Code, msg string, cause error) *CodedError

+ func (e *CodedError) Code() errtax.Code

+ func (e *CodedError) Error() string

+ func (e *CodedError) Unwrap() error

+ type NotFoundError struct

+ Err error

+ Message string

+ func NewNotFoundError(message string, err error) *NotFoundError

+ func (e *NotFoundError) Code() errtax.Code

+ func (e *NotFoundError) Error() string

+ func (e *NotFoundError) Unwrap() error

v0.10.0

Jul 7, 2026

Changes in this version

+ func ForeignFlagSuggestions(flag string) []string

+ func HyperlinkPreStyled(url, styledText string) string

+ func KnownTotal(total int) *int

+ func SanitizeTerminalBlock(s string) string

+ func WriteAliasListPlain(w io.Writer, command string, data any, opts ...PlainOption) error

type CLIInputError

+ func (e *CLIInputError) Code() errtax.Code

+ func (e *CLIInputError) FlagName() string

type Error

+ Suggestions []string

+ UpstreamRequestID string

type Meta

+ UpstreamRequestID string

type PlainOption

+ func WithPlainGraphemeWidth(grapheme bool) PlainOption

+ func WithPlainResultKey(key string) PlainOption

type PromptError

+ func (e *PromptError) Code() errtax.Code

+ type ReleaseNotesResult struct

+ Markdown string

+ Releases []changelog.Release

v0.6.0

Jun 11, 2026

v0.5.1

Jun 9, 2026

v0.5.0

Jun 9, 2026

v0.4.1

Jun 8, 2026

v0.4.0

Jun 8, 2026

Changes in this version

+ func SentenceCase(s string) string

+ type OperationVerb struct

+ Gerund string

+ Infinitive string

+ Noun string

+ Past string

+ func VerbFor(op string) OperationVerb

+ func (v OperationVerb) Failuref() string

+ func (v OperationVerb) GerundPlural() string

+ func (v OperationVerb) Gerundf() string

+ func (v OperationVerb) NounPlural() string

+ func (v OperationVerb) PastPlural() string

+ func (v OperationVerb) Pastf() string

v0.3.3

Jun 4, 2026

v0.3.2

Jun 2, 2026

v0.3.1

Jun 1, 2026

v0.3.0

Jun 1, 2026

Changes in this version

+ func ValidateIssueColumns(selected []string) error

type Detection

+ StdinPiped bool

type PlainOption

+ func WithPlainColumns(columns []string) PlainOption

+ func WithPlainTSV(tsv bool) PlainOption

v0.2.0

May 29, 2026

Changes in this version

+ func WriteIssueViewFailureDiagnostics(w io.Writer, data any, errorsOut []Error) error

+ func WriteKeyedResultsFailureDiagnostics(w io.Writer, data any, errorsOut []Error) error

+ func WriteKeyedResultsPlain(w io.Writer, command string, data any, opts ...PlainOption) error

type PlainOption

+ func WithPlainDebug(debug bool) PlainOption

+ func WithPlainParallel(parallel bool) PlainOption

+ func WithPlainThreads(threads int) PlainOption

v0.1.2

May 28, 2026

v0.1.1

May 28, 2026

Changes in this version

+ func WriteHumanJSON(w io.Writer, data any) error

v0.1.0

May 28, 2026

Changes in this version

+ var OutputModeValues = []string

+ func ExitCode(err Error) int

+ func Hyperlink(url, text string) string

+ func NewRequestID() string

+ func RouteWarnings(opts RouteOptions) error

+ func SanitizeCompletionField(s string) string

+ func SanitizeTerminalText(s string) string

+ func Suggest(input string, candidates []string) []string

+ func WriteAttachmentListPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WriteBoardListPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WriteCommandPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WriteCommentListPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WriteCompact(w io.Writer, data any) error

+ func WriteEnvelope(w io.Writer, env Envelope) error

+ func WriteIssueTransitionsPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WriteIssueViewPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WriteLinkListPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WriteLinkTypesPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ func WritePlain(w io.Writer, data any) error

+ func WriteWatcherListPlain(w io.Writer, command string, data any, opts ...PlainOption) error

+ type AgentName string

+ type CLIInputError struct

+ Flag string

+ Kind CLIInputKind

+ Message string

+ Suggestions []string

+ func NewCLIInputError(kind CLIInputKind, message string) *CLIInputError

+ func (e *CLIInputError) Error() string

+ type CLIInputKind int

+ const InputArgCountInvalid

+ const InputArgValueInvalid

+ const InputCommandUnknown

+ const InputFlagSyntaxInvalid

+ const InputFlagUnknown

+ const InputFlagValueInvalid

+ const InputFlagValueMissing

+ const InputRequiredFlagMissing

+ type CommandSchema struct

+ Command string

+ Flags []FlagSchema

+ OutputSchema map[string]any

+ type Detection struct

+ Agent bool

+ AgentName string

+ IsTTY bool

+ Mode Mode

+ func Detect(stdout *os.File) Detection

+ func RequireTTY(stdout *os.File) (Detection, error)

+ type Envelope struct

+ Data any

+ Errors []Error

+ Meta Meta

+ OK bool

+ Warnings []Warning

+ func ErrorEnvelope(command string, err error) Envelope

+ type Error struct

+ Candidates []map[string]any

+ Code string

+ Field string

+ Flag string

+ HTTPStatus int

+ Hint string

+ Message string

+ Path string

+ Provider string

+ RateLimitRemaining int

+ RetryAfterSeconds int

+ Retryable bool

+ Type string

+ UpstreamCode string

+ UpstreamFieldErrors map[string]string

+ UpstreamMessages []string

+ UpstreamStatus int

+ func MapError(err error) Error

+ func NewError(kind ErrorType, msg string) Error

+ type ErrorType string

+ const ErrorTypeAuth

+ const ErrorTypeNotFound

+ const ErrorTypeRateLimit

+ const ErrorTypeServer

+ const ErrorTypeValidation

+ type FlagSchema struct

+ Name string

+ Type string

+ type Meta struct

+ Command string

+ ExitCode *int

+ Pagination *Pagination

+ RequestID string

+ Timestamp string

+ type Mode string

+ const ModeCompact

+ const ModeJSON

+ const ModePlain

+ const ModeTUI

+ func ResolveOutputMode(out OutputMode, det Detection) Mode

+ type OutputMode string

+ const OutputAuto

+ const OutputCompact

+ const OutputHuman

+ const OutputJSON

+ func ParseOutputMode(v string) (OutputMode, error)

+ type Pagination struct

+ IsLast bool

+ MaxResults int

+ NextCursor string

+ StartAt int

+ Total int

+ type PlainOption func(*plainConfig)

+ func WithPlainBaseURL(baseURL string) PlainOption

+ func WithPlainTTY(tty bool) PlainOption

+ func WithPlainTermWidth(width int) PlainOption

+ func WithPlainTheme(theme *clibtheme.Theme) PlainOption

+ type PlainRenderer interface

+ RenderPlain func(w io.Writer, command string, data any, opts ...PlainOption) error

+ type PromptError struct

+ Err error

+ Kind PromptKind

+ Prompt string

+ func NewPromptError(kind PromptKind, prompt string, err error) *PromptError

+ func (e *PromptError) Error() string

+ func (e *PromptError) Unwrap() error

+ type PromptKind int

+ const PromptAborted

+ const PromptCanceled

+ const PromptUnavailable

+ type RouteMode int

+ const RouteCompact

+ const RouteJSON

+ const RoutePlain

+ type RouteOptions struct

+ Command string

+ Data any

+ Envelope Envelope

+ Mode RouteMode

+ Plain []PlainOption

+ Stderr io.Writer

+ Stdout io.Writer

+ Warnings []Warning

+ type SchemaRegistry struct

+ func NewSchemaRegistry() *SchemaRegistry

+ func (r *SchemaRegistry) Commands() []string

+ func (r *SchemaRegistry) Get(command string) (CommandSchema, bool)

+ func (r *SchemaRegistry) Register(schema CommandSchema)

+ type ValidationCandidatesError interface

+ BoardCandidates func() []map[string]any

+ type Warning struct

+ Field string

+ Lossy bool

+ MarkType string

+ Message string

+ NodeType string

+ Path string

+ Type string

+ func WarningFrom(src WarningSource) Warning

+ type WarningSource interface

+ WarningField func() string

+ WarningIsLossy func() bool

+ WarningMarkType func() string

+ WarningMessage func() string

+ WarningNodeType func() string

+ WarningPath func() string

+ WarningType func() string

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