Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

entity

package

Go to main page

Versions in this module

v1

v1.21.34

Jun 30, 2026

v1.21.33

Jun 28, 2026

v1.21.32

Jun 26, 2026

v1.21.31

Jun 26, 2026

v1.21.30

Jun 26, 2026

v1.21.29

Jun 26, 2026

Changes in this version

+ const SourceCustom

+ const SourceEntity

+ const SourceFunc

+ const SourceStatic

+ var ParseArgs = func(args []string) (map[string]any, error)

+ var RenderResult = func(o any) error

+ func AddCommandWithContext[T any, R any](parent *cobra.Command, opts T, fn func(ctx context.Context, opts T) (R, error)) *cobra.Command

+ func AddCommand[T any, R any](parent *cobra.Command, opts T, fn func(opts T) (R, error)) *cobra.Command

+ func AddNamedCommandWithContext[T any, R any](name string, parent *cobra.Command, opts T, ...) *cobra.Command

+ func AddNamedCommand[T any, R any](name string, parent *cobra.Command, opts T, fn func(opts T) (R, error)) *cobra.Command

+ func GenerateCLI(parent *cobra.Command)

+ func GetDataFunc(cmd *cobra.Command) func(flags map[string]string, args []string) (any, error)

+ func GetLookupFunc(cmd *cobra.Command) func(flags map[string]string, args []string) (any, error)

+ func RegisterDynamicEntity(spec DynamicEntitySpec)

+ func RegisterEntity[T EntityItem, ListOpts any, R any](e Entity[T, ListOpts, R])

+ func RegisterFilter(f NamedFilter)

+ func RegisterFilterSpec(s FilterSpec)

+ func RegisterSubCommand(parentName string, cmd *cobra.Command)

+ func RegisterSubCommandFn(parentName string, build func(parent *cobra.Command))

+ func SetCommandResponseMeta(cmd *cobra.Command, meta ResponseOpenAPIMeta)

+ func Use[ListOpts any](filterName string) *attachedFilter[ListOpts]

+ type ActionFlags interface

+ ClickyActionFlags func()

+ type ActionInfo struct

+ ContextDataFunc ContextDataFunc

+ DataFunc func(flags map[string]string, args []string) (any, error)

+ FlagsType reflect.Type

+ Method string

+ Name string

+ OptionalID bool

+ ResponseType reflect.Type

+ Short string

+ ToolGroup string

+ type ActionSpec struct

+ func ActionWithContext[R any](name string, ...) *ActionSpec[R]

+ func ActionWithFlagsAndContext[R any](name string, flags ActionFlags, ...) *ActionSpec[R]

+ func ActionWithFlags[R any](name string, flags ActionFlags, ...) *ActionSpec[R]

+ func Action[R any](name string, fn func(id string, flags map[string]string) (R, error)) *ActionSpec[R]

+ func (a *ActionSpec[R]) WithFlags(flags ActionFlags) *ActionSpec[R]

+ func (a *ActionSpec[R]) WithMethod(method string) *ActionSpec[R]

+ func (a *ActionSpec[R]) WithOptionalID() *ActionSpec[R]

+ func (a *ActionSpec[R]) WithShort(short string) *ActionSpec[R]

+ func (a *ActionSpec[R]) WithToolGroup(group string) *ActionSpec[R]

+ type BulkActionInfo struct

+ BindCompletions func(cmd *cobra.Command)

+ ContextLookupFunc ContextLookupFunc

+ DataFunc func(flags map[string]string, args []string) (any, error)

+ FilterFunc func(flags map[string]string, args []string) (any, error)

+ ListType reflect.Type

+ LookupFunc func(flags map[string]string, args []string) (any, error)

+ Name string

+ ResponseType reflect.Type

+ Short string

+ type BulkActionSpec struct

+ func BulkActionWithFilter[ListOpts any, R any](name string, run func(ids []string, flags map[string]string) (R, error), ...) *BulkActionSpec[R]

+ func BulkAction[R any](name string, fn func(ids []string, flags map[string]string) (R, error)) *BulkActionSpec[R]

+ func BulkFilterAction[ListOpts any, R any](name string, fn func(opts ListOpts, flags map[string]string) (R, error)) *BulkActionSpec[R]

+ func (b *BulkActionSpec[R]) WithShort(short string) *BulkActionSpec[R]

+ type ClickyOperationMeta struct

+ ActionName string

+ Admin bool

+ Aliases []string

+ Command string

+ Entity string

+ Group string

+ IDParam string

+ Icon string

+ Order int

+ Parent string

+ Scope string

+ SupportsFilterMode bool

+ SupportsLookup bool

+ Surface string

+ SurfaceID string

+ Title string

+ Verb string

+ type ClickySpecMeta struct

+ Surfaces []ClickySurface

+ type ClickySurface struct

+ Admin bool

+ Description string

+ Entity string

+ Icon string

+ Key string

+ Order int

+ Parent string

+ Title string

+ type CommandOpenAPIMeta struct

+ ActionName string

+ Admin bool

+ Aliases []string

+ Entity string

+ IDParam string

+ Icon string

+ Method string

+ OptionalID bool

+ Parent string

+ Scope string

+ SupportsFilterMode bool

+ SupportsLookup bool

+ Title string

+ ToolGroup string

+ Verb string

+ func GetCommandOpenAPIMeta(cmd *cobra.Command) *CommandOpenAPIMeta

+ type Config struct

+ AutoGeneratePaths bool

+ DefaultMethod string

+ DefaultTags []string

+ PathPrefix string

+ func DefaultConfig() *Config

+ type ContextDataFunc = func(ctx context.Context, flags map[string]string, args []string) (any, error)

+ func GetContextDataFunc(cmd *cobra.Command) ContextDataFunc

+ type ContextFilter interface

+ OptionsWithContext func(ctx context.Context, opts ListOpts) map[string]api.Textable

+ type ContextLookupFunc = func(ctx context.Context, flags map[string]string, args []string) (any, error)

+ func GetContextLookupFunc(cmd *cobra.Command) ContextLookupFunc

+ type ContextSearchableFilter interface

+ OptionsWithQueryAndContext func(ctx context.Context, opts ListOpts, query string, limit int) (options map[string]api.Textable, total int)

+ type DataFunc func(flags map[string]string, args []string) (any, error)

+ type DynamicEntityBuilder struct

+ func NewDynamicEntity(name string, schema []byte) *DynamicEntityBuilder

+ func (b *DynamicEntityBuilder) Get(fn DynamicGetFunc) *DynamicEntityBuilder

+ func (b *DynamicEntityBuilder) List(fn DynamicListFunc) *DynamicEntityBuilder

+ func (b *DynamicEntityBuilder) Register()

+ type DynamicEntitySpec struct

+ Aliases []string

+ FilterRefs map[string]string

+ Filters []DynamicFilter

+ Get ContextDataFunc

+ Icon string

+ ItemType reflect.Type

+ List ContextDataFunc

+ ListType reflect.Type

+ Name string

+ Parent string

+ Title string

+ type DynamicFilter struct

+ Key string

+ Label string

+ Multi bool

+ Options func(ctx context.Context, flags map[string]string, query string, limit int) (map[string]api.Textable, int)

+ Searchable bool

+ Selected func(ctx context.Context, flags map[string]string) map[string]api.Textable

+ Type string

+ type DynamicGetFunc func(ctx context.Context, id string) (map[string]any, error)

+ type DynamicListFunc func(ctx context.Context, opts map[string]string) ([]map[string]any, error)

+ type Entity struct

+ Actions []EntityAction

+ Admin *Entity[T, ListOpts, R]

+ Aliases []string

+ BulkActions []EntityBulkAction

+ Create func(body map[string]any) (R, error)

+ CreateWithContext func(ctx context.Context, body map[string]any) (R, error)

+ Delete func(id string) error

+ DeleteWithContext func(ctx context.Context, id string) error

+ Filters []Filter[ListOpts]

+ Get func(id string) (R, error)

+ GetFlags ActionFlags

+ GetWithContext func(ctx context.Context, id string) (R, error)

+ GetWithFlags func(id string, flags map[string]string) (R, error)

+ GetWithFlagsAndContext func(ctx context.Context, id string, flags map[string]string) (R, error)

+ List func(opts ListOpts) ([]T, error)

+ ListPaged func(opts ListOpts) (PagedResult[T], error)

+ ListPagedWithContext func(ctx context.Context, opts ListOpts) (PagedResult[T], error)

+ ListWithContext func(ctx context.Context, opts ListOpts) ([]T, error)

+ Name string

+ Parent string

+ ToolGroup string

+ Update func(id string, body map[string]any) (R, error)

+ UpdateWithContext func(ctx context.Context, id string, body map[string]any) (R, error)

+ ValidArgs func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ type EntityAction interface

+ type EntityBuilder struct

+ func NewEntity[T EntityItem, ListOpts any, R any](name string) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Admin(admin Entity[T, ListOpts, R]) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Aliases(aliases ...string) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Build() Entity[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Create(fn func(map[string]any) (R, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) CreateWithContext(fn func(context.Context, map[string]any) (R, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Delete(fn func(string) error) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) DeleteWithContext(fn func(context.Context, string) error) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Filters(filters ...Filter[ListOpts]) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Get(fn func(string) (R, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) GetWithContext(fn func(context.Context, string) (R, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) GetWithFlags(flags ActionFlags, fn func(string, map[string]string) (R, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) List(fn func(ListOpts) ([]T, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) ListPaged(fn func(ListOpts) (PagedResult[T], error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) ListPagedWithContext(fn func(context.Context, ListOpts) (PagedResult[T], error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) ListWithContext(fn func(context.Context, ListOpts) ([]T, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Parent(parent string) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Register()

+ func (b *EntityBuilder[T, ListOpts, R]) ToolGroup(group string) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) Update(fn func(string, map[string]any) (R, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) UpdateWithContext(fn func(context.Context, string, map[string]any) (R, error)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) ValidArgs(fn func(*cobra.Command, []string, string) ([]string, cobra.ShellCompDirective)) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) WithAction(action EntityAction) *EntityBuilder[T, ListOpts, R]

+ func (b *EntityBuilder[T, ListOpts, R]) WithBulkAction(action EntityBulkAction) *EntityBuilder[T, ListOpts, R]

+ type EntityBulkAction interface

+ type EntityInfo struct

+ Actions []ActionInfo

+ Aliases []string

+ BulkActions []BulkActionInfo

+ FilterRefs map[string]string

+ Icon string

+ IsAdmin bool

+ ListType reflect.Type

+ Name string

+ Operations []EntityOperation

+ Parent string

+ Title string

+ ToolGroup string

+ Type reflect.Type

+ ValidArgs func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func GetEntities() []EntityInfo

+ func GetEntity(name string) (EntityInfo, bool)

+ type EntityItem interface

+ GetID func() string

+ GetName func() string

+ type EntityOperation struct

+ BindCompletions func(cmd *cobra.Command)

+ ContextDataFunc ContextDataFunc

+ ContextLookupFunc ContextLookupFunc

+ DataFunc func(flags map[string]string, args []string) (any, error)

+ FlagsType reflect.Type

+ LookupFunc func(flags map[string]string, args []string) (any, error)

+ Method string

+ ResponseArray bool

+ ResponseEntityID bool

+ ResponsePaged bool

+ ResponseType reflect.Type

+ Verb string

+ type ExecutableCommand interface

+ Execute func(ctx context.Context, opts ExecuteOptions) (stdout, stderr string, err error)

+ Hidden func() bool

+ IsBoolFlag func(name string) bool

+ Name func() string

+ Path func() string

+ RootName func() string

+ Runnable func() bool

+ type ExecuteOptions struct

+ Args []string

+ Flags map[string]string

+ FormatOverrides map[string]string

+ type Filter interface

+ Key func() string

+ Label func() string

+ Lookup func(opts *ListOpts) (map[string]api.Textable, error)

+ Options func(opts ListOpts) map[string]api.Textable

+ func LiftFilters[Outer any, Inner any](filters []Filter[Inner], project func(*Outer) *Inner) []Filter[Outer]

+ type FilterContext struct

+ Context context.Context

+ Key string

+ Params map[string]string

+ func (fc FilterContext) Ctx() context.Context

+ type FilterSource interface

+ Options func(fc FilterContext, query string, limit int) (options map[string]api.Textable, total int, err error)

+ Resolve func(fc FilterContext, values []string) (map[string]api.Textable, error)

+ func EntityOptions(entityName string) FilterSource

+ func FuncOptions(...) FilterSource

+ func StaticOptions(options map[string]api.Textable) FilterSource

+ type FilterSourceSpec struct

+ Entity string

+ Kind string

+ Options map[string]string

+ type FilterSpec struct

+ Label string

+ Multi bool

+ Name string

+ Source FilterSourceSpec

+ Type string

+ type Filterable interface

+ Filters func() []Filter[T]

+ type Help interface

+ Help func() api.Textable

+ type MultiFilter []string

+ type Name interface

+ GetName func() string

+ type NamedFilter struct

+ Label string

+ Multi bool

+ Name string

+ Source FilterSource

+ Type string

+ func FilterFromSpec(s FilterSpec) (NamedFilter, error)

+ func GetFilter(name string) (NamedFilter, bool)

+ func MustGetFilter(name string) NamedFilter

+ func (f NamedFilter) Spec() FilterSpec

+ type PageInfo struct

+ Limit int

+ Offset int

+ Total int64

+ type Paged interface

+ PageMetadata func() PageInfo

+ PageRows func() any

+ type PagedResult struct

+ Data []T

+ Page PageInfo

+ func NewPagedResult[T any](rows []T, limit, offset int, total int64) PagedResult[T]

+ func (p PagedResult[T]) PageMetadata() PageInfo

+ func (p PagedResult[T]) PageRows() any

+ type Property struct

+ Default interface{}

+ Description string

+ Enum []string

+ Type string

+ type RPCOperation struct

+ Clicky *ClickyOperationMeta

+ Command ExecutableCommand

+ ContextDataFunc ContextDataFunc

+ ContextLookupFunc ContextLookupFunc

+ DataFunc DataFunc

+ Description string

+ Group string

+ LookupFunc DataFunc

+ Method string

+ Name string

+ Parameters []RPCParameter

+ Path string

+ ResponseArray bool

+ ResponseEntityID bool

+ ResponsePaged bool

+ ResponseType reflect.Type

+ Schema Schema

+ Tags []string

+ type RPCParameter struct

+ Default interface{}

+ Description string

+ In string

+ Name string

+ Required bool

+ Type string

+ type RPCService struct

+ Description string

+ Name string

+ Operations []RPCOperation

+ Version string

+ type ResponseOpenAPIMeta struct

+ Array bool

+ EntityID bool

+ Paged bool

+ Type reflect.Type

+ func GetCommandResponseMeta(cmd *cobra.Command) *ResponseOpenAPIMeta

+ type Schema struct

+ Properties map[string]Property

+ Required []string

+ Type string

+ type SearchableFilter interface

+ OptionsWithQuery func(opts ListOpts, query string, limit int) (options map[string]api.Textable, total int)

+ type TypedFilter interface

+ LookupType func() string