cli

Documentation

Index

• Constants
• Variables
• func CheckWithMessage(err error, message string)
• func ContextSelector(context ConfigContext) string
• func DefaultClient() *openapi_client.APIClient
• func Exit(code int)
• func GetAPIToken() string
• func GetAPIURL() string
• func GetOutputFormat() string
• func NewAPIClient(config *ClientConfig) *openapi_client.APIClient
• func NewCurrentContext(context ConfigContext) core.ConfigContext
• func SaveContexts(contexts []ConfigContext) error
• func WriteConfig() error
• type ClientConfig
  • func NewClientConfig() *ClientConfig
• type ConfigContext
  • func GetContexts() []ConfigContext
  • func GetCurrentContext() (ConfigContext, bool)
  • func SaveCurrentContextBySelector(selector string) (*ConfigContext, error)
  • func UpsertContext(context ConfigContext) (ConfigContext, error)
• type ConnectCommand
  • func (c *ConnectCommand) Execute(ctx core.CommandContext) error
• type ContextsCommand
  • func (c *ContextsCommand) Execute(ctx core.CommandContext) error
• type CurrentContext
  • func (c *CurrentContext) GetActiveCanvas() string
  • func (c *CurrentContext) SetActiveCanvas(canvasID string) error

Constants

const (
	DefaultAPIURL           = "http://localhost:8000"
	ConfigKeyOutput         = "output"
	ConfigKeyContexts       = "contexts"
	ConfigKeyCurrentContext = "currentContext"
)

Variables

var OutputFormat string

var RootCmd = &cobra.Command{
	Use:   "superplane",
	Short: "SuperPlane command line interface",
	Long:  `SuperPlane CLI - Command line interface for the SuperPlane API`,
	PersistentPreRun: func(cmd *cobra.Command, args []string) {
		if !Verbose {
			log.SetOutput(io.Discard)
		}
	},
}

var Verbose bool

Functions

func CheckWithMessage

func CheckWithMessage(err error, message string)

Checks if an error is present.

If it is present, it displays the provided message and exits with status 1.

func ContextSelector

func ContextSelector(context ConfigContext) string

func DefaultClient

func DefaultClient() *openapi_client.APIClient

func Exit

func Exit(code int)

func GetAPIToken

func GetAPIToken() string

func GetAPIURL

func GetAPIURL() string

func GetOutputFormat

func GetOutputFormat() string

func NewAPIClient

func NewAPIClient(config *ClientConfig) *openapi_client.APIClient

func NewCurrentContext

func NewCurrentContext(context ConfigContext) core.ConfigContext

func SaveContexts

func SaveContexts(contexts []ConfigContext) error

func WriteConfig

func WriteConfig() error

Types

type ClientConfig

type ClientConfig struct {
	BaseURL    string
	APIToken   string
	HTTPClient *http.Client
}

func NewClientConfig

func NewClientConfig() *ClientConfig

type ConfigContext

type ConfigContext struct {
	URL          string  `json:"url" yaml:"url"`
	Organization string  `json:"organization" yaml:"organization"`
	APIToken     string  `json:"apiToken" yaml:"apiToken"`
	Canvas       *string `json:"canvas,omitempty" yaml:"canvas,omitempty"`
}

func GetContexts

func GetContexts() []ConfigContext

func GetCurrentContext

func GetCurrentContext() (ConfigContext, bool)

func SaveCurrentContextBySelector

func SaveCurrentContextBySelector(selector string) (*ConfigContext, error)

func UpsertContext

func UpsertContext(context ConfigContext) (ConfigContext, error)

type ConnectCommand

type ConnectCommand struct{}

func (*ConnectCommand) Execute

func (c *ConnectCommand) Execute(ctx core.CommandContext) error

type ContextsCommand

type ContextsCommand struct{}

func (*ContextsCommand) Execute

func (c *ContextsCommand) Execute(ctx core.CommandContext) error

type CurrentContext

type CurrentContext struct {
	// contains filtered or unexported fields
}

* Implementation of the core.ConfigContext interface, * which uses the current context as the source for operations..

func (*CurrentContext) GetActiveCanvas

func (c *CurrentContext) GetActiveCanvas() string

func (*CurrentContext) SetActiveCanvas

func (c *CurrentContext) SetActiveCanvas(canvasID string) error