Documentation
¶
Index ¶
- Variables
- func AppRoot() (appRoot, relPath string)
- func AppSlug() string
- func AppSlugOrLocalID() 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 ClearTerminalExceptFirstNLines(n int)
- 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 FindAppRootFromDir(dir string) (appRoot, relPath string, err error)
- func FormatStack(val any, buf *bytes.Buffer) error
- func IsDaemonRunning(ctx context.Context) bool
- func MaybeAppRoot() (appRoot, relPath string, err error)
- func StartDaemonInBackground(ctx context.Context) error
- func StopDaemon()
- func StreamCommandOutput(stream CommandOutputStream, converter OutputConverter) int
- func WorkspaceRoot(appRoot string) string
- type CommandOutputStream
- type ConvertLogOption
- type ConvertLogOptions
- type Oneof
- type OutputConverter
Constants ¶
This section is empty.
Variables ¶
var ( ErrNoEncoreApp = errors.New("no encore.app found in directory (or any of the parent directories)") ErrEncoreAppIsDir = errors.New("encore.app is a directory, not a file") )
var Newline string
Functions ¶
func AppRoot ¶
func AppRoot() (appRoot, relPath string)
AppRoot is like MaybeAppRoot but instead of returning an error it prints it to stderr 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 AppSlugOrLocalID ¶
func AppSlugOrLocalID() string
func AutoCompleteAppSlug ¶
func AutoCompleteEnvSlug ¶
func ClearTerminalExceptFirstNLines ¶
func ClearTerminalExceptFirstNLines(n int)
func ConnectDaemon ¶
func ConnectDaemon(ctx context.Context) daemonpb.DaemonClient
ConnectDaemon returns a client connection to the Encore daemon. By default, it will start the daemon if it is not already running.
func DisplayError ¶
func FindAppRootFromDir ¶
func IsDaemonRunning ¶
func MaybeAppRoot ¶
MaybeAppRoot 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.
func StartDaemonInBackground ¶
StartDaemonInBackground starts the Encore daemon in the background.
func StopDaemon ¶
func StopDaemon()
func StreamCommandOutput ¶
func StreamCommandOutput(stream CommandOutputStream, converter OutputConverter) int
StreamCommandOutput streams the output from the given command stream, and reports the command's exit code. If convertJSON is true, lines that look like JSON are fed through zerolog's console writer.
func WorkspaceRoot ¶
WorkspaceRoot determines the workspace root by looking for the .git folder in app root or parents to it. It reports the absolute path to the workspace root.
Types ¶
type CommandOutputStream ¶
type CommandOutputStream interface {
Recv() (*daemon.CommandMessage, error)
}
CommandOutputStream is the interface for gRPC streams that stream the output of a command.
type ConvertLogOption ¶
type ConvertLogOption func(*ConvertLogOptions)
func Colorize ¶
func Colorize(enable bool) ConvertLogOption
type ConvertLogOptions ¶
type ConvertLogOptions struct {
Color bool
}
type Oneof ¶
type Oneof struct {
Value string
Allowed []string
Flag string // defaults to "output" if empty
FlagShort string // defaults to "o" if both Flag and FlagShort are empty
Desc string // usage desc
TypeDesc string // type description, defaults to the name of the flag
NoOptDefVal string // default value when no option is provided
}
func (*Oneof) Alternatives ¶
Alternatives lists the alternatives in the format "a|b|c".
type OutputConverter ¶
func ConvertJSONLogs ¶
func ConvertJSONLogs(opts ...ConvertLogOption) OutputConverter
Source Files