config

Documentation

Overview

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com>

SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com>

SPDX-License-Identifier: BSD-3-Clause

Index

• type Action
• type Alias
• type Call
• type Column
  • func (c *Column) Get(v any) (any, error)
  • func (c Column) String() string
• type Columns
  • func ParseColumns(s string) Columns
• type Config
  • func For(provider string) Config
• type Configs
  • func Defaults() Configs
• type Entity
• type Flag
• type FlagConfig
• type FlagSet
  • func (fs FlagSet) Get(name string) (Flag, bool)
  • func (fs FlagSet) Names() []string
• type Prompt
• type Spec
  • func (s Spec) ForAttribute(call, name string) SpecAttribute
  • func (s Spec) ForCall(name string) SpecCall
  • func (s *Spec) SetAttribute(call, name string, spec SpecAttribute)
• type SpecAttribute
• type SpecCall

Types

type Action

type Action string

const (
	ActionDelete Action = "delete"
)

type Alias

type Alias struct {
	Entity  string   `yaml:"entity"`
	Use     string   `yaml:"use"`
	AliasTo string   `yaml:"alias_to,omitempty"`
	Aliases []string `yaml:"aliases,omitempty"`
	Short   string   `yaml:"short,omitempty"`
	Command []string `yaml:"command"`
	Flags   FlagSet  `yaml:"flags,omitempty"`
	Prompt  *Prompt  `yaml:"prompt,omitempty"`
}

type Call

type Call struct {
	Content string  `yaml:"content,omitempty"`
	Entity  string  `yaml:"entity,omitempty"`
	Group   string  `yaml:"group,omitempty"`
	AliasTo string  `yaml:"alias_to,omitempty"`
	Short   string  `yaml:"short,omitempty"`
	Flags   FlagSet `yaml:"flags,omitempty"`
}

type Column

type Column struct {
	Title   string `yaml:"title"`
	Content string `yaml:"content"`
	Primary bool   `yaml:"primary,omitempty"`
	// contains filtered or unexported fields
}

func (*Column) Get

func (c *Column) Get(v any) (any, error)

func (Column) String

func (c Column) String() string

type Columns

type Columns []Column

func ParseColumns

func ParseColumns(s string) Columns

type Config

type Config struct {
	DefaultContent string            `yaml:"default_content,omitempty"`
	Calls          map[string]Call   `yaml:"contents,omitempty"`
	Entities       map[string]Entity `yaml:"entities,omitempty"`
	Aliases        []Alias           `yaml:"aliases,omitempty"`
	Spec           Spec              `yaml:"spec,omitzero"`
}

func For

func For(provider string) Config

type Configs

type Configs map[string]Config

func Defaults

func Defaults() Configs

type Entity

type Entity struct {
	Skip      bool     `yaml:"skip,omitempty"`
	NoAliases bool     `yaml:"no_aliases,omitempty"`
	Explode   bool     `yaml:"explode,omitempty"`
	Sort      bool     `yaml:"sort,omitempty"`
	Aliases   []string `yaml:"aliases,omitempty"`
	Columns   Columns  `yaml:"columns,omitempty"`
	Primary   string   `yaml:"primary,omitempty"`
}

type Flag

type Flag struct {
	Name     string `yaml:"name"`
	AliasTo  string `yaml:"alias_to,omitempty"`
	Required bool   `yaml:"required,omitempty"`
	Type     string `yaml:"type,omitempty"`
	Usage    string `yaml:"usage,omitempty"`
}

type FlagConfig

type FlagConfig struct {
	AppliesTo  string `yaml:"applies_to"`
	TrimPrefix string `yaml:"trim_prefix"`
}

type FlagSet

type FlagSet []Flag

func (FlagSet) Get

func (fs FlagSet) Get(name string) (Flag, bool)

func (FlagSet) Names

func (fs FlagSet) Names() []string

type Prompt

type Prompt struct {
	Action         Action   `yaml:"action"`
	DisplayCommand []string `yaml:"display,omitempty"`
	Flags          FlagSet  `yaml:"flags,omitempty"`
}

type Spec

type Spec struct {
	Calls      map[string]SpecCall      `yaml:"calls,omitempty"`
	Attributes map[string]SpecAttribute `yaml:"attributes,omitempty"`
}

func (Spec) ForAttribute

func (s Spec) ForAttribute(call, name string) SpecAttribute

func (Spec) ForCall

func (s Spec) ForCall(name string) SpecCall

func (*Spec) SetAttribute

func (s *Spec) SetAttribute(call, name string, spec SpecAttribute)

type SpecAttribute

type SpecAttribute struct {
	Help     string `yaml:"help,omitempty"`
	Required bool   `yaml:"required,omitempty"`
}

type SpecCall

type SpecCall struct {
	Help string `yaml:"help,omitempty"`
}