docs

Jun 14, 2026

Changes in this version

+ func NewCommand() *cobra.Command

+ func NewCommandWithConfig(cfg *DocsConfig) *cobra.Command

+ func RenderCLIReference(m *Model) string

+ func RenderController(ctrl ControllerDoc) string

+ func RenderSingleFile(m *Model, format string) (string, error)

+ func RenderUISurfaces(m *Model) string

+ type CommandDoc struct

+ Aliases []string

+ Example string

+ Flags []FlagDoc

+ Long string

+ Path string

+ Short string

+ Use string

+ type ControllerDoc struct

+ Commands []CommandDoc

+ Long string

+ Name string

+ Short string

+ type DocsConfig struct

+ Depth int

+ Description string

+ Exclude []string

+ Title string

+ type FlagDoc struct

+ Default interface{}

+ Name string

+ Required bool

+ Shorthand string

+ Type string

+ Usage string

+ type Model struct

+ Commands []CommandDoc

+ Controllers []ControllerDoc

+ Description string

+ Surfaces []SurfaceDoc

+ Title string

+ Version string

+ func BuildModel(root *cobra.Command, cfg *DocsConfig) (*Model, error)

+ type Page struct

+ Body string

+ Description string

+ Generated bool

+ Key string

+ Title string

+ type ParameterDoc struct

+ Default interface{}

+ In string

+ Name string

+ Required bool

+ Role string

+ Type string

+ type ScaffoldResult struct

+ Actions []WriteAction

+ Dir string

+ func Scaffold(m *Model, dir string, force bool) (*ScaffoldResult, error)

+ type SurfaceDoc struct

+ Command string

+ Entity string

+ Lookup bool

+ Method string

+ Parameters []ParameterDoc

+ Path string

+ Verb string

+ type WriteAction struct

+ Path string

+ Skipped bool

+ Status string