cmdutil

Documentation

Index

• Variables
• func AppRoot() (appRoot, relPath string)
• func AppSlug() string
• func AutoCompleteAppSlug(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)
• func AutoCompleteEnvSlug(cmd *cobra.Command, args []string, toComplete string) (rtn []string, dir cobra.ShellCompDirective)
• func AutoCompleteFromStaticList(args ...string) ...
• func ConnectDaemon(ctx context.Context) daemonpb.DaemonClient
• func DisplayError(out *os.File, err []byte)
• func Fatal(args ...any)
• func Fatalf(format string, args ...any)
• func StartDaemonInBackground(ctx context.Context) error
• func StopDaemon()
• type Output
  • func (o *Output) AddFlag(s *pflag.FlagSet)
  • func (o *Output) Set(v string) error
  • func (o *Output) String() string
  • func (o *Output) Type() string
  • func (o *Output) Usage() string

Variables

var Newline string

Functions

func AppRoot

func AppRoot() (appRoot, relPath string)

AppRoot determines the app root by looking for the "encore.app" file, initially in the current directory and then recursively in parent directories up to the filesystem root.

It reports the absolute path to the app root, and the relative path from the app root to the working directory.

On errors it prints an error message and exits.

func AppSlug

func AppSlug() string

AppSlug reports the current app's app slug. It throws a fatal error if the app is not connected with the Encore Platform.

func AutoCompleteAppSlug

func AutoCompleteAppSlug(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

func AutoCompleteEnvSlug

func AutoCompleteEnvSlug(cmd *cobra.Command, args []string, toComplete string) (rtn []string, dir cobra.ShellCompDirective)

func AutoCompleteFromStaticList

func AutoCompleteFromStaticList(args ...string) func(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

func ConnectDaemon

func ConnectDaemon(ctx context.Context) daemonpb.DaemonClient

ConnectDaemon sets up the Encore daemon if it isn't already running and returns a client connected to it.

func DisplayError

func DisplayError(out *os.File, err []byte)

func Fatal

func Fatal(args ...any)

func Fatalf

func Fatalf(format string, args ...any)

func StartDaemonInBackground

func StartDaemonInBackground(ctx context.Context) error

StartDaemonInBackground starts the Encore daemon in the background.

func StopDaemon

func StopDaemon()

Types

type Output

type Output struct {
	Value   string
	Allowed []string
}

func (*Output) AddFlag

func (o *Output) AddFlag(s *pflag.FlagSet)

func (*Output) Set

func (o *Output) Set(v string) error

func (*Output) String

func (o *Output) String() string

func (*Output) Type

func (o *Output) Type() string

func (*Output) Usage

func (o *Output) Usage() string