onboard

Documentation

Overview

Package onboard provides interactive .env creation for new team members.

Index

• func NeedsOnboarding(envFile string) bool
• type Onboarder
  • func New(w io.Writer, r io.Reader, schema map[string]config.EnvVar) *Onboarder
  • func (o *Onboarder) Run(envFile, exampleFile string) error

Functions

func NeedsOnboarding

func NeedsOnboarding(envFile string) bool

NeedsOnboarding returns true if the .env file does not exist.

Types

type Onboarder

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

Onboarder walks new developers through creating a .env file interactively.

func New

func New(w io.Writer, r io.Reader, schema map[string]config.EnvVar) *Onboarder

New creates an Onboarder that reads from r, writes prompts to w, and uses the provided schema for defaults and descriptions.

func (*Onboarder) Run

func (o *Onboarder) Run(envFile, exampleFile string) error

Run shows available keys from .env.example and schema, prompts the user for values, and creates the envFile. Returns nil on success or an error if the user cancels.