environment

package

v6.2.2 Latest Latest Go to latest Published: Sep 30, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/steadybit/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package environment implements the `environment` commands.

Index ¶

Variables
func Apply(ctx context.Context, c *platform.Client, o ApplyOptions) error
func Delete(ctx context.Context, c *platform.Client, o DeleteOptions) error
func Get(ctx context.Context, c *platform.Client, o GetOptions) error
func GetVariables(ctx context.Context, c *platform.Client, o VariableGetOptions) error
func List(ctx context.Context, c *platform.Client, o ListOptions) error
func SetVariables(ctx context.Context, c *platform.Client, pairs []string, o VariableSetOptions) error
type ApplyOptions
type DeleteOptions
type GetOptions
type ListOptions
type VariableGetOptions
type VariableSetOptions

Constants ¶

This section is empty.

Variables ¶

View Source

var ReadOnly = []string{"version", "state"}

The state is the platform's, and the version is dropped as `service get` drops it: kept in a file, it turns every apply after an edit in the UI into a conflict.

Functions ¶

func Apply ¶

func Apply(ctx context.Context, c *platform.Client, o ApplyOptions) error

func Delete ¶

func Delete(ctx context.Context, c *platform.Client, o DeleteOptions) error

func Get ¶

func Get(ctx context.Context, c *platform.Client, o GetOptions) error

func GetVariables ¶

func GetVariables(ctx context.Context, c *platform.Client, o VariableGetOptions) error

func List ¶

func List(ctx context.Context, c *platform.Client, o ListOptions) error

func SetVariables ¶

func SetVariables(ctx context.Context, c *platform.Client, pairs []string, o VariableSetOptions) error

SetVariables merges KEY=VALUE arguments over a file's variables with PUT; with --replace, POST makes them the only ones.

Types ¶

type ApplyOptions ¶

type ApplyOptions struct {
	Files     []string
	Recursive bool
}

type DeleteOptions ¶

type DeleteOptions struct {
	ID  string
	Yes bool
}

type GetOptions ¶

type GetOptions struct {
	ID, File, Type string
}

type ListOptions ¶

type ListOptions struct {
	Search string
	Type   string
}

type VariableGetOptions ¶

type VariableGetOptions struct {
	ID, Type string
}

type VariableSetOptions ¶

type VariableSetOptions struct {
	ID      string
	File    string
	Replace bool
}

Source Files ¶

View all Source files

environment.go

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