Documentation
¶
Overview ¶
Package command implements helpers useful for when building cobra commands.
Index ¶
- Variables
- func ChangeWorkingDirectory(ctx context.Context, wd string) (context.Context, error)
- func ChangeWorkingDirectoryToFirstArgIfPresent(ctx context.Context) (context.Context, error)
- func FromContext(ctx context.Context) *cobra.Command
- func IsMachinesPlatform(ctx context.Context, appName string) (bool, error)
- func LoadAppConfigIfPresent(ctx context.Context) (context.Context, error)
- func LoadAppNameIfPresent(ctx context.Context) (context.Context, error)
- func New(usage, short, long string, fn Runner, p ...Preparer) *cobra.Command
- func NewContext(ctx context.Context, cmd *cobra.Command) context.Context
- func RequireAppName(ctx context.Context) (context.Context, error)
- func RequireSession(ctx context.Context) (context.Context, error)
- func WrapRunE(fn func(*cobra.Command, []string) error) func(*cobra.Command, []string) error
- type Preparer
- type Runner
Constants ¶
This section is empty.
Variables ¶
var ErrNotImplementedYet = errors.New("command not implemented yet")
TODO: remove once all commands are implemented.
Functions ¶
func ChangeWorkingDirectory ¶ added in v0.0.452
func FromContext ¶
FromContext returns the Command ctx carries. It panics in case ctx carries no Command.
func IsMachinesPlatform ¶ added in v0.0.503
func LoadAppConfigIfPresent ¶
LoadAppConfigIfPresent is a Preparer which loads the application's configuration file from the path the user has selected via command line args or the current working directory.
func LoadAppNameIfPresent ¶
LoadAppNameIfPresent is a Preparer which adds app name if the user has used --app or there appConfig but unlike RequireAppName it does not error if the user has not specified an app name.
func NewContext ¶
NewContext derives a context that carries cmd from ctx.
func RequireAppName ¶
RequireAppName is a Preparer which makes sure the user has selected an application name via command line arguments, the environment or an application config file (fly.toml). It embeds LoadAppConfigIfPresent.
func RequireSession ¶
RequireSession is a Preparer which makes sure a session exists.
Types ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent implements the agent command chain.
|
Package agent implements the agent command chain. |
|
Package apps implements the apps command chain.
|
Package apps implements the apps command chain. |
|
Package auth implements the auth command chain.
|
Package auth implements the auth command chain. |
|
Package curl implements the curl command chain.
|
Package curl implements the curl command chain. |
|
Package dig implements the dig command chain.
|
Package dig implements the dig command chain. |
|
Package docs implements the docs command chain.
|
Package docs implements the docs command chain. |
|
Package doctor implements the doctor command chain.
|
Package doctor implements the doctor command chain. |
|
Package history implements the history command chain.
|
Package history implements the history command chain. |
|
Package logs implements the logs command chain.
|
Package logs implements the logs command chain. |
|
Package platform implements the platform command chain.
|
Package platform implements the platform command chain. |
|
Package root implements the root command.
|
Package root implements the root command. |
|
Package status implements the status command chain.
|
Package status implements the status command chain. |
|
Package version implements the version command chain.
|
Package version implements the version command chain. |