Versions in this module Expand all Collapse all v3 v3.9.0 Oct 6, 2026 Changes in this version type Ctx + MutationFlags []FieldMutation + MutationOrderCaptured bool + RequestPreview io.Writer + type FieldMutation struct + HasValue bool + Key string + Kind MutationKind + Raw string + Value string + type FieldTypeHandler struct + Encode func(field spec.FieldDef, current any) (any, error) + Mutate func(field spec.FieldDef, current any, op FieldMutation) (next any, write bool, err error) + Normalize func(field spec.FieldDef, current any) (any, error) + type MutationKind string + const MutationAdd + const MutationDelete + const MutationSet type Resolver + ResolveFieldType func(id string) (FieldTypeHandler, bool) v3.8.0 Sep 28, 2026 Changes in this version type Ctx + ProvidedFlags map[string]bool + func (c *Ctx) RemoveFlag(name string) + func (c *Ctx) SetFlag(name string, value any) type UILink + ProvidedFlags map[string]bool v3.7.1 Sep 8, 2026 Changes in this version type Ctx + RestoreOffset int + UIWantBack bool type UILink + Offset int v3.7.0 Sep 4, 2026 Changes in this version + func Exists(fv map[string]any, key string) bool + func GetBool(fv map[string]any, key string) bool + func GetFloat64(fv map[string]any, key string) float64 + func GetInt(fv map[string]any, key string) int + func GetString(fv map[string]any, key string) string + func GetStringSlice(fv map[string]any, key string) []string + func IsTimeout(err error) bool + func NormalizeFileBody(body, ct, filePath string) (string, string, error) + func SlurpInputFile(fv map[string]any) (string, error) + type CreateBodyFn func(ctx *Ctx) (any, error) + type Ctx struct + Args []string + Auth *auth.ResolvedAuth + CancelFn context.CancelCauseFunc + Context context.Context + DelArgs []string + FieldsNoun string + FlagValues map[string]any + FormatFlags FormatFlags + GlobalFlags GlobalFlags + Id string + IdParts []string + IsCompletion bool + IsPty bool + Level string + MigrateFrom string + MigrateTo string + Noun string + PagingFlags PagingFlags + ParentId string + Resolver Resolver + RestoreListPos int + SetArgs map[string]string + UIHistory []UILink + Verb string + VerbHandler string + func (c *Ctx) AccountAuth() *auth.ResolvedAuth + func (c *Ctx) OrgAuth() *auth.ResolvedAuth + func (c *Ctx) PopUILink() (link UILink, ok bool) + func (c *Ctx) PushUILink(link UILink) + func (c *Ctx) ScopedAuth() *auth.ResolvedAuth + type DataAccessor interface + GetBool func(path string) bool + GetData func() any + GetInt64 func(path string) int64 + GetSlice func(path string) []any + GetString func(path string) string + GetTs func(path string) string + type EndpointRequest struct + Body any + ContentType string + Method string + Path string + QueryParams map[string]string + type EndpointValidatorFn func(ctx *Ctx, req EndpointRequest) error + type FetchFn func(ctx *Ctx, ep *spec.EndpointSpec, wantStart, wantCount int, cursor any) (*PageResult, error) + type FlagResolveFn func(ctx *Ctx, raw string) (*FlagResolveResult, error) + type FlagResolveResult struct + Defaults map[string]string + Value string + type FollowFn func(ctx *Ctx, result any) error + type FormatFlags struct + Columns string + Fields string + Format string + NoHeaders bool + OutFile string + Raw bool + type GlobalFlags struct + type ItemFn func(ctx *Ctx) (any, error) + type ListTransformFn func(ctx *Ctx, data any) (items []any, fields []spec.FieldDef, meta PageMeta, err error) + type PageMeta struct + Count int + HasTotal bool + Notice string + Offset int + Total int64 + type PageResult struct + HasTotal bool + Items []any + Last bool + NextCursor any + Raw any + StartOffset int + Total int64 + type PagingFlags struct + All bool + Count bool + Limit int + Offset int + OnPage func(fetched int, total int64, hasTotal bool) + type QueryParamsFn func(ctx *Ctx) (map[string]string, error) + type RawBody struct + Content string + ContentType string + type Resolver interface + FetchItems func(ctx *Ctx, ep *spec.EndpointSpec, pf PagingFlags) ([]any, error) + FormatList func(ctx *Ctx, rows []any, fields []spec.FieldDef, columnIDs []string) error + GetAllSpecs func() []*spec.CommandSpec + GetHiddenModule func(name string) *spec.ModuleMeta + GetModuleMetas func() []spec.ModuleMeta + GetNoun func(noun string) *spec.NounDef + GetSpec func(verb, noun string) *spec.CommandSpec + GetSpecsForModule func(module string) []*spec.CommandSpec + GetVerbInfos func() []spec.VerbInfo + ResolveBodyFn func(id string) CreateBodyFn + ResolveCommandFields func(cs *spec.CommandSpec) []spec.FieldDef + ResolveEndpointValidator func(id string) EndpointValidatorFn + ResolveFetchFn func(id string) (FetchFn, error) + ResolveFlagResolveFn func(id string) FlagResolveFn + ResolveItemFn func(id string) ItemFn + ResolveListTransformFn func(id string) ListTransformFn + ResolveNounAlias func(alias string) string + ResolveQueryParamsFn func(id string) QueryParamsFn + ResolveTextFormatter func(id string) TextFormatterFn + RunEndpoint func(ctx *Ctx, ep *spec.EndpointSpec) (any, error) + RunUIHandler func(ctx *Ctx, fnID string) error + type TextFormatterFn func(w io.Writer, d DataAccessor) error + type TimeoutError struct + Secs float64 + func (e *TimeoutError) Error() string + type UILink struct + FlagValues map[string]any + Id string + IdParts []string + Level string + ListPos int + Noun string + Org string + Profile string + Project string + Screen UIScreenKind + Verb string + type UIScreenKind int + const ScreenDetailForGet + const ScreenTable + const ScreenTableForGet
Go to main page