config

package
v0.3.27 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const DefaultClientID = "builder-cli"

DefaultClientID is the default client ID using the PKCE flow.

View Source
const DefaultPath = "~/.builder/builder.db"

DefaultPath is the default store file name.

View Source
const DefaultSpecFileName = ".builder.yaml"

DefaultSpecFileName is the default spec file name.

View Source
const UnknownCwd = ""

UnknownCwd is the unknown current working directory.

Variables

View Source
var DefaultConfig = New()

DefaultConfig is the default configuration.

Functions

func ExpandConfigPath added in v0.3.5

func ExpandConfigPath(path string) (string, error)

ExpandConfigPath expands the config path and creates the store folder.

Types

type Config

type Config struct {
	File     string
	FileMode os.FileMode
	Flags    Flags
	Stderr   *os.File
	Stdin    *os.File
	Stdout   *os.File
	Task     TaskFlags
	Verbose  bool
}

Config contains the configuration.

func New

func New() Config

New returns a new config.

func (*Config) Abs added in v0.3.25

func (c *Config) Abs() (string, error)

Abs returns the absolute path of the config file.

func (*Config) Cwd

func (c *Config) Cwd() (string, error)

Cwd return the current working directory. Which is the path in which the builder spec is located.

func (*Config) DeleteStore added in v0.3.17

func (c *Config) DeleteStore() error

DeleteStore deletes the session store.

func (*Config) HomeDir

func (c *Config) HomeDir() (string, error)

HomeDir returns the home directory.

func (*Config) Path

func (c *Config) Path() (string, error)

Path returns the expanded path of the config file.

func (*Config) Spec

func (c *Config) Spec() (*specs.Spec, error)

Spec is a helper to load the spec from the config file.

func (*Config) StorePath added in v0.3.25

func (c *Config) StorePath() (string, error)

StorePath returns the path to the store file.

func (*Config) Vars

func (c *Config) Vars() []string

Vars returns the variables.

type Flags

type Flags struct {
	// URL is the URL of the OIDC provider.
	URL string
	// Plugins contains the plugins to use.
	Plugins []string
	// Vars contains the variables to use.
	Vars []string
	// Dry indicates whether to print dry run messages.
	Dry bool
	// Force indicates whether to force overwrite.
	Force bool
	// Root is the root directory of the project.
	Root bool
	// Verbose indicates whether to print verbose messages.
	Verbose bool
	// Version indicates whether to print version.
	Version bool
	// TaskFlags contains the flags for a task.
	TaskFlags TaskFlags
	// Path is the path to the project.
	Path string
}

Flags contains the command line flags.

func NewDefaultFlags added in v0.3.25

func NewDefaultFlags() Flags

NewDefaultFlags returns the default flags.

func NewFlags

func NewFlags() Flags

NewFlags returns a new flags.

type TaskFlags

type TaskFlags struct {
	// Name is the name of the task to execute.
	Name string
}

TaskFlags contains the flags for a task.

Jump to

Keyboard shortcuts

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