flags

Documentation

Overview

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Define(c *cobra.Command, o interface{}, startingGroup string)
• func GetDefaults(o interface{}) map[string]string
• func GetField(o interface{}, name string) reflect.Value
• func GetNames(o interface{}) map[string]string
• func Transform(ctx context.Context, o interface{}) error
• func Validate(o interface{}) []error
• type ConfigFlags
  • func NewConfigFlags() (*ConfigFlags, error)
  • func (o *ConfigFlags) Transform(ctx context.Context) error
  • func (o *ConfigFlags) Validate() []error
• type JSONFlags
  • func (o *JSONFlags) GetOutput(ctx context.Context, input io.Reader, output io.Writer) error
  • func (o *JSONFlags) GetQuery() string
  • func (o *JSONFlags) IsJSON() bool
• type RegistryFlags
  • func (o *RegistryFlags) Transform(ctx context.Context) error
  • func (o *RegistryFlags) Validate() []error

Variables

var EnvPrefix = "lstn"

EnvPrefix is the prefix of the env variables corresponding to the global flags.

var EnvSeparator = "_"

EnvSeparator is the separator between the env variable prefix and the global flag name.

Functions

func Define

func Define(c *cobra.Command, o interface{}, startingGroup string)

func GetDefaults

func GetDefaults(o interface{}) map[string]string

func GetField

func GetField(o interface{}, name string) reflect.Value

func GetNames

func GetNames(o interface{}) map[string]string

func Transform

func Transform(ctx context.Context, o interface{}) error

func Validate

func Validate(o interface{}) []error

Types

type ConfigFlags

type ConfigFlags struct {
	LogLevel string `default:"info" name:"log level" flag:"loglevel" desc:"set the logging level"`                           // TODO > validator
	Timeout  int    `default:"60" name:"timeout" flag:"timeout" desc:"set the timeout, in seconds" validate:"number,min=30"` // FIXME: change to time.Duration type
	Endpoint string ``                                                                                                       /* 163-byte string literal not displayed */
}

func NewConfigFlags

func NewConfigFlags() (*ConfigFlags, error)

func (*ConfigFlags) Transform

func (o *ConfigFlags) Transform(ctx context.Context) error

func (*ConfigFlags) Validate

func (o *ConfigFlags) Validate() []error

type JSONFlags

type JSONFlags struct {
	JSON bool   `name:"json" flag:"json" desc:"output the verdicts (if any) in JSON form"`
	JQ   string `name:"jq" flag:"jq" shorthand:"q" desc:"filter the output using a jq expression" validate:"excluded_without=JSON,jq"`
}

func (*JSONFlags) GetOutput

func (o *JSONFlags) GetOutput(ctx context.Context, input io.Reader, output io.Writer) error

func (*JSONFlags) GetQuery

func (o *JSONFlags) GetQuery() string

func (*JSONFlags) IsJSON

func (o *JSONFlags) IsJSON() bool

type RegistryFlags

type RegistryFlags struct {
	URL string `` /* 144-byte string literal not displayed */
}

func (*RegistryFlags) Transform

func (o *RegistryFlags) Transform(ctx context.Context) error

func (*RegistryFlags) Validate

func (o *RegistryFlags) Validate() []error