SpinnerModel struct

Fields:

  • spinner (*pterm.SpinnerPrinter)
  • message (string)
  • finished (bool)

Methods:

UpdateMessage

Parameters:
  • message string
Show/Hide Method Body 
{
	m.spinner.UpdateText(message)
}

Stop

Stop stops the spinner and marks it as finished.

Example:

spinner := myApp.CLI.StartSpinner("Loading the batmobile...")
time.Sleep(3 * time.Second)
spinner.Stop()
Show/Hide Method Body 
{
	if !m.finished {
		m.spinner.Stop()
		m.finished = true
	}
}

newSpinnerModel function

Parameters:

  • message string

Returns:

  • *SpinnerModel
Show/Hide Function Body 
{
	spinner, _ := pterm.DefaultSpinner.Start(message)
	spinner.Sequence = []string{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"}
	return &SpinnerModel{
		spinner: spinner,
		message: message,
	}
}

NewCLI function

NewCLI sets up the CLI for the application using CLIOptions.

Parameters:

  • options *types.CLIOptions

Returns:

  • *Command
Show/Hide Function Body 
{
	rootCmd := &cobra.Command{
		Use:   options.Use,
		Short: options.Short,
		Long:  options.Long,
	}

	cli := &Command{
		Command: rootCmd,
	}

	cli.addManCommand()

	return cli
}

Command struct

Command is the root command for the application.

Fields:

  • children ([]*Command)

Methods:

StartSpinner

StartSpinner starts a spinner with a message.

The spinner can be stopped by calling the Stop method on the returned model.

Parameters:
  • message string
Returns:
  • *SpinnerModel

Example:

spinner := myApp.CLI.StartSpinner("Loading the batmobile...")
time.Sleep(3 * time.Second)
spinner.Stop()
Show/Hide Method Body 
{
	model := newSpinnerModel(message)
	return model
}

StartProgressBar

StartProgressBar starts a progress bar with a message and a total

The progress bar is stopped automatically when it reaches the total or

manually by calling the Stop method on the returned model.

Parameters:
  • message string
  • total int
Returns:
  • *ProgressBarModel

Example:

progressBar := myApp.CLI.StartProgressBar("Loading the batmobile...", 100)
for i := 0; i < 100; i++ {
	progressBar.Increment(1)
	time.Sleep(50 * time.Millisecond)
}
Show/Hide Method Body 
{
	model := newProgressBarModel()
	model.progressBar, _ = pterm.DefaultProgressbar.WithTotal(total).WithTitle(message).Start()
	return model
}

NewCommand function

NewCommand returns a new Command with the provided inputs. Alias for

NewCommandRunE.

Parameters:

  • use string
  • long string
  • short string
  • runE func(cmd *cobra.Command, args []string) error

Returns:

  • *Command
Show/Hide Function Body 
{
	return NewCommandRunE(use, long, short, runE)
}

NewCommandRunE function

NewCommandRunE returns a new Command with the provided inputs. The runE function

is used for commands that return an error.

Parameters:

  • use string
  • long string
  • short string
  • runE func(cmd *cobra.Command, args []string) error

Returns:

  • *Command
Show/Hide Function Body 
{
	cmd := &cobra.Command{
		Use:   use,
		Short: short,
		Long:  long,
		RunE:  runE,
	}
	return &Command{
		Command:  cmd,
		children: make([]*Command, 0),
	}
}

NewCommandRun function

NewCommandRun returns a new Command with the provided inputs. The run function

is used for commands that do not return an error.

Parameters:

  • use string
  • long string
  • short string
  • run func(cmd *cobra.Command, args []string)

Returns:

  • *Command
Show/Hide Function Body 
{
	cmd := &cobra.Command{
		Use:   use,
		Short: short,
		Long:  long,
		Run:   run,
	}
	return &Command{
		Command:  cmd,
		children: make([]*Command, 0),
	}
}

NewCommandCustom function

NewCustomCommand returns a Command created from

the provided cobra.Command

Parameters:

  • cmd *cobra.Command

Returns:

  • *Command
Show/Hide Function Body 
{
	return &Command{
		Command:  cmd,
		children: make([]*Command, 0),
	}
}

ProgressBarModel struct

ProgressBarModel represents a progress bar model

Fields:

  • progressBar (*pterm.ProgressbarPrinter)
  • finished (bool)

Methods:

UpdateMessage

UpdateMessage updates the message of the progress bar

Parameters:
  • message string
Show/Hide Method Body 
{
	m.progressBar.UpdateTitle(message)
}

Increment

UpdateProgress increments the progress of the progress bar only if it

has not reached the total.

Parameters:
  • progress int

Example:

progressBar := myApp.CLI.StartProgressBar("Loading the batmobile...", 100)
progressBar.Increment(50)
Show/Hide Method Body 
{
	if m.progressBar.Total != m.progressBar.Current {
		m.progressBar.Add(progress)
	} else {
		m.Stop()
	}
}

Stop

Stop stops the progress bar and marks it as finished.

Example:

progressBar := myApp.CLI.StartProgressBar("Loading the batmobile...", 100)
progressBar.Increment(50)
progressBar.UpdateMessage("Failed to load the batmobile")
progressBar.Stop()
Show/Hide Method Body 
{
	if !m.finished {
		m.progressBar.Stop()
		m.finished = true
	}
}

newProgressBarModel function

newProgressBarModel creates a new progress bar model

Returns:

  • *ProgressBarModel
Show/Hide Function Body 
{
	return &ProgressBarModel{}
}

fmt import

Import example:

import "fmt"

github.com/AlecAivazis/survey/v2 import

Import example:

import "github.com/AlecAivazis/survey/v2"

github.com/pterm/pterm import

Import example:

import "github.com/pterm/pterm"

fmt import

Import example:

import "fmt"

github.com/AlecAivazis/survey/v2 import

Import example:

import "github.com/AlecAivazis/survey/v2"

fmt import

Import example:

import "fmt"

github.com/AlecAivazis/survey/v2 import

Import example:

import "github.com/AlecAivazis/survey/v2"

fmt import

Import example:

import "fmt"

time import

Import example:

import "time"

github.com/spf13/cobra import

Import example:

import "github.com/spf13/cobra"

github.com/vanilla-os/sdk/pkg/v1/cli/types import

Import example:

import "github.com/vanilla-os/sdk/pkg/v1/cli/types"

github.com/vanilla-os/sdk/pkg/v1/roff import

Import example:

import "github.com/vanilla-os/sdk/pkg/v1/roff"

github.com/pterm/pterm import

Import example:

import "github.com/pterm/pterm"