cli

Documentation

Overview

Package cli provides the CLI client, i.e. the `otf` binary.

Index

• Constants
• type CLI
  • func NewCLI() *CLI
  • func (a *CLI) Run(ctx context.Context, args []string, out io.Writer) error
• type CredentialsConfig
• type CredentialsStore
  • func NewCredentialsStore() (CredentialsStore, error)
  • func (c CredentialsStore) Load(hostname string) (string, error)
  • func (c CredentialsStore) Save(hostname, token string) error
• type KVMap
  • func (m KVMap) Load(key string) (string, error)
  • func (m KVMap) Save(key, value string) error
• type KVStore
• type TokenConfig

Constants

const (
	CredentialsPath = ".terraform.d/credentials.tfrc.json"
)

Types

type CLI

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

CLI is the `otf` cli application

func NewCLI

func NewCLI() *CLI

func (*CLI) Run

func (a *CLI) Run(ctx context.Context, args []string, out io.Writer) error

type CredentialsConfig

type CredentialsConfig struct {
	Credentials map[string]TokenConfig `json:"credentials"`
}

type CredentialsStore

type CredentialsStore string

CredentialsStore is a JSON file in a user's home dir that stores tokens for one or more TFE-type hosts

func NewCredentialsStore

func NewCredentialsStore() (CredentialsStore, error)

NewCredentialsStore is a contructor for CredentialsStore

func (CredentialsStore) Load

func (c CredentialsStore) Load(hostname string) (string, error)

Load retrieves the token for hostname

func (CredentialsStore) Save

func (c CredentialsStore) Save(hostname, token string) error

Save saves the token for the given hostname to the store, overwriting any existing tokens for the hostname.

type KVMap

type KVMap map[string]string

KVMap is a basic implementation of http.KVStore for testing purposes.

func (KVMap) Load

func (m KVMap) Load(key string) (string, error)

func (KVMap) Save

func (m KVMap) Save(key, value string) error

type KVStore

type KVStore interface {
	Save(key, value string) error
	Load(key string) (value string, err error)
}

KVStore implementations provide a key-value store.

type TokenConfig

type TokenConfig struct {
	Token string `json:"token"`
}