keygen

Documentation

Index

• func GenerateKeys(host string) tea.Cmd
• func NewProgram(host string, fancy bool) *tea.Program
• type DoneMsg
• type FailedMsg
  • func (f FailedMsg) Error() string
• type Model
  • func NewModel() Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type Status
• type SuccessMsg

Functions

func GenerateKeys

func GenerateKeys(host string) tea.Cmd

GenerateKeys is a Bubble Tea command that generates a pair of SSH keys and writes them to disk.

func NewProgram

func NewProgram(host string, fancy bool) *tea.Program

NewProgram creates a new keygen TUI program

Types

type DoneMsg

type DoneMsg struct{}

DoneMsg is sent when the keygen has completely finished running.

type FailedMsg

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

FailedMsg is a Bubble Tea message for keygen failure

func (FailedMsg) Error

func (f FailedMsg) Error() string

Error returns the underlying error

type Model

type Model struct {
	Status Status
	// contains filtered or unexported fields
}

Model is the Bubble Tea model which stores the state of the keygen.

func NewModel

func NewModel() Model

NewModel returns a new keygen model in its initial state.

func (Model) Init

func (m Model) Init() tea.Cmd

Init is the Bubble Tea initialization function for the keygen.

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update is the Bubble Tea update loop for the keygen.

func (Model) View

func (m Model) View() string

View renders the view from the keygen model.

type Status

type Status int

Status represents a keygen state

const (
	StatusRunning Status = iota
	StatusError
	StatusSuccess
	StatusDone
	StatusQuitting
)

General states

type SuccessMsg

type SuccessMsg struct{}

SuccessMsg is a Bubble Tea message for keygen success