token

Documentation

Index

• Variables
• func Delete(name string) error
• func Dir() (string, error)
• func ProfilePath(name string) (string, error)
• func ValidateProfileName(name string) error
• func Write(name string, token Token, force bool) error
• type Token
  • func Read(name string) (Token, error)

Variables

var (
	// ErrProfileNotFound is returned when a requested profile file does not exist.
	ErrProfileNotFound = errors.New("profile not found")
	// ErrProfileExists is returned when writing an existing profile without force.
	ErrProfileExists = errors.New("profile already exists")
)

Functions

func Delete

func Delete(name string) error

Delete removes a token profile and ignores missing files.

func Dir

func Dir() (string, error)

Dir returns the directory used for profile token files.

func ProfilePath

func ProfilePath(name string) (string, error)

ProfilePath returns the JSON file path for a validated profile name.

func ValidateProfileName

func ValidateProfileName(name string) error

ValidateProfileName returns an error unless name is a safe profile identifier.

func Write

func Write(name string, token Token, force bool) error

Write persists a token profile, refusing to overwrite unless force is true.

Types

type Token

type Token struct {
	Token          string `json:"token"`
	APIURL         string `json:"api_url"`
	AgentName      string `json:"agent_name"`
	Team           string `json:"team"`
	TeamSlug       string `json:"team_slug"`
	CreatedByEmail string `json:"created_by_email"`
	CreatedAt      string `json:"created_at"`
}

Token stores the persisted credentials and profile metadata.

func Read

func Read(name string) (Token, error)

Read loads a token profile unless DISBUG_TOKEN provides an environment override.