Help us shape the future of Go! Take the 2026 Go Developer Survey

cli

package
v1.7.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 1, 2026 License: Apache-2.0 Imports: 37 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Conformance

type Conformance struct {
	Conformance string   `arg:"" help:"conformance string" required:""`
	Params      []string `arg:"" help:"parameters to use to evaluate conformance" optional:""`
}

func (*Conformance) Run

func (cmd *Conformance) Run(cc *Context) (err error)

type Context

type Context struct {
	context.Context

	Kong *kong.Context
}

type DataModel

type DataModel struct {
	common.ASCIIDocAttributes  `embed:""`
	spec.ParserOptions         `embed:""`
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`
	dm.DataModelOptions        `embed:""`

	spec.FilterOptions `embed:""`
}

func (*DataModel) Run

func (c *DataModel) Run(cc *Context) (err error)

type Disco

type Disco struct {
	disco.DiscoOptions `embed:""`

	spec.ParserOptions         `embed:""`
	common.ASCIIDocAttributes  `embed:""`
	pipeline.ProcessingOptions `embed:""`
	render.RenderOptions       `embed:""`
	files.OutputOptions        `embed:""`

	Paths []string `arg:"" optional:"" help:"The paths of AsciiDoc files to disco-ball. If not specified, all files will be disco-balled."`
}

func (*Disco) Run

func (d *Disco) Run(cc *Context) (err error)

type ErrDiff added in v1.5.56

type ErrDiff struct {
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`

	spec.FilterOptions `embed:""`

	HeadRoot string `name:"head-root" default:"connectedhomeip-spec" help:"the src root of your clone of CHIP-Specifications/connectedhomeip-spec"`
	BaseRoot string `name:"base-root" default:"connectedhomeip-spec" help:"the src root of your clone of CHIP-Specifications/connectedhomeip-spec"`
}

func (*ErrDiff) Run added in v1.5.56

func (c *ErrDiff) Run(cc *Context) (err error)

type Format

type Format struct {
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`
	render.RenderOptions       `embed:""`

	Paths []string `arg:"" help:"Paths of AsciiDoc files to format" required:""`
}

func (*Format) Run

func (f *Format) Run(cc *Context) (err error)

type IDL added in v1.6.19

type IDL struct {
	IDLRegen              IDLRegen              `cmd:"" name:"regen"`
	IDLControllerClusters IDLControllerClusters `cmd:"" name:"controller-clusters"`
}

type IDLControllerClusters added in v1.6.19

type IDLControllerClusters struct {
	common.ASCIIDocAttributes  `embed:""`
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`
	spec.ParserOptions         `embed:""`
	Output                     string `` /* 169-byte string literal not displayed */
	SuppressProvisional        string `name:"suppress-provisional" help:"Suppress rendering of provisional elements" default:"all" enum:"none,all"`
	PerTrait                   bool   `name:"per-trait" help:"Generate a separate IDL file for each cluster"`
	KeepLongStrings            bool   `name:"keep-long-strings" help:"Keep 'long_' prefix on string types" default:"false"`
}

func (*IDLControllerClusters) Run added in v1.6.19

func (z *IDLControllerClusters) Run(cc *Context) (err error)

type IDLRegen added in v1.6.19

type IDLRegen struct {
	common.ASCIIDocAttributes  `embed:""`
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`
	spec.ParserOptions         `embed:""`
	spec.FilterOptions         `embed:""`
	sdk.SDKOptions             `embed:""`
	SuppressProvisional        string `name:"suppress-provisional" help:"Suppress rendering of provisional elements" default:"all" enum:"none,all,keep-existing"`
	KeepLongStrings            bool   `name:"keep-long-strings" help:"Keep 'long_' prefix on string types" default:"false"`
}

func (*IDLRegen) Run added in v1.6.19

func (z *IDLRegen) Run(cc *Context) (err error)

type MLE added in v1.6.4

type MLE struct {
	common.ASCIIDocAttributes  `embed:""`
	pipeline.ProcessingOptions `embed:""`
	spec.ParserOptions         `embed:""`
}

func (*MLE) Run added in v1.6.4

func (m *MLE) Run(cc *Context) (err error)

type Provisional added in v1.6.0

type Provisional struct {
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`

	spec.FilterOptions `embed:""`

	HeadRoot string `` /* 147-byte string literal not displayed */
	BaseRoot string `` /* 147-byte string literal not displayed */
}

func (*Provisional) Run added in v1.6.0

func (c *Provisional) Run(cc *Context) (err error)

type StripComments added in v1.6.19

type StripComments struct {
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`

	Paths []string `arg:"" help:"Paths of files to strip comments from" required:""`
}

func (*StripComments) Run added in v1.6.19

func (f *StripComments) Run(cc *Context) (err error)

type TestPlan

type TestPlan struct {
	testplanRender.RendererOptions `embed:""`

	common.ASCIIDocAttributes  `embed:""`
	spec.ParserOptions         `embed:""`
	spec.FilterOptions         `embed:""`
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`
}

func (*TestPlan) Run

func (c *TestPlan) Run(cc *Context) (err error)

type TestScript

type TestScript struct {
	sdk.SDKOptions             `embed:""`
	common.ASCIIDocAttributes  `embed:""`
	pipeline.ProcessingOptions `embed:""`
	spec.ParserOptions         `embed:""`
	spec.FilterOptions         `embed:""`
	python.GeneratorOptions    `embed:""`
	files.OutputOptions        `embed:""`
}

func (*TestScript) Run

func (cmd *TestScript) Run(cc *Context) (err error)

type Validate

type Validate struct {
	common.ASCIIDocAttributes  `embed:""`
	spec.ParserOptions         `embed:""`
	pipeline.ProcessingOptions `embed:""`
}

func (*Validate) Run

func (c *Validate) Run(cc *Context) (err error)

type Wordlist

type Wordlist struct {
	spec.ParserOptions `embed:""`
}

func (*Wordlist) Run

func (f *Wordlist) Run(cc *Context) (err error)

type Yaml2Python

type Yaml2Python struct {
	common.ASCIIDocAttributes  `embed:""`
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`
	spec.ParserOptions         `embed:""`
	render.RenderOptions       `embed:""`
	sdk.SDKOptions             `embed:""`
	python.GeneratorOptions    `embed:""`

	Paths []string `arg:""`
}

func (*Yaml2Python) Run

func (c *Yaml2Python) Run(cc *Context) (err error)

type ZAP

type ZAP struct {
	common.ASCIIDocAttributes  `embed:""`
	pipeline.ProcessingOptions `embed:""`
	files.OutputOptions        `embed:""`
	spec.ParserOptions         `embed:""`
	spec.FilterOptions         `embed:""`
	sdk.SDKOptions             `embed:""`
	render.TemplateOptions     `embed:""`
}

func (*ZAP) Run

func (z *ZAP) Run(cc *Context) (err error)

type ZAPDiff added in v1.6.14

type ZAPDiff struct {
	XmlRoot1      string `help:"root of first set of ZAP XMLs" group:"SDK Commands:" required:"true"`
	XmlRoot2      string `help:"root of second set of ZAP XMLs" group:"SDK Commands:" required:"true"`
	Label1        string `default:"ZapXML-1" help:"label for first set of ZAP XMLs" group:"SDK Commands:"`
	Label2        string `default:"ZapXML-2" help:"label for second set of ZAP XMLs" group:"SDK Commands:"`
	Out           string `default:"." help:"path to output mismatch files" group:"SDK Commands:"`
	Format        string `default:"both" help:"output format: csv, html, or both" group:"SDK Commands:"`
	MismatchLevel int    `default:"3" help:"the minimum mismatch level to report (1-3)" group:"SDK Commands:"`
}

func (*ZAPDiff) Run added in v1.6.14

func (z *ZAPDiff) Run(cc *Context) (err error)

Jump to

Keyboard shortcuts

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