Documentation
¶
Index ¶
Constants ¶
View Source
const ( CardinalPort = "4040" RedisPort = "6379" )
View Source
const (
// DockerCardinalEnvLogLevel Environment variable name for Docker.
DockerCardinalEnvLogLevel = "CARDINAL_LOG_LEVEL"
)
Variables ¶
View Source
var CardinalCmdPlugin struct { Cardinal *CardinalCmd `cmd:"" group:"Cardinal Commands:" help:"Manage your Cardinal game shard"` }
View Source
var (
ErrGracefulExit = eris.New("Process gracefully exited")
)
Functions ¶
This section is empty.
Types ¶
type BuildCmd ¶ added in v1.8.0
type BuildCmd struct {
Parent *CardinalCmd `kong:"-"`
LogLevel string ` flag:"" help:"Set the log level for Cardinal"`
Debug bool ` flag:"" help:"Enable debugging"`
Telemetry bool ` flag:"" help:"Enable tracing, metrics, and profiling"`
Push string ` flag:"" help:"Push your cardinal image to a given image repository" hidden:"true"`
Auth string ` flag:"" help:"Auth token for the given image repository" hidden:"true"`
User string ` flag:"" help:"User for the given image repository" hidden:"true"`
Pass string ` flag:"" help:"Password for the given image repository" hidden:"true"`
RegToken string ` flag:"" help:"Registry token for the given image repository" hidden:"true"`
}
type CardinalCmd ¶ added in v1.8.0
type CardinalCmd struct {
Config string `flag:"" type:"existingfile" help:"A TOML config file"`
Start *StartCmd `cmd:"" group:"Cardinal Commands:" help:"Launch your Cardinal game environment"`
Stop *StopCmd `cmd:"" group:"Cardinal Commands:" help:"Gracefully shut down your Cardinal game environment"`
Restart *RestartCmd `cmd:"" group:"Cardinal Commands:" help:"Restart your Cardinal game environment"`
Dev *DevCmd `cmd:"" group:"Cardinal Commands:" help:"Run Cardinal in fast development mode with hot reloading"`
Purge *PurgeCmd `cmd:"" group:"Cardinal Commands:" help:"Reset your Cardinal game shard to a clean state by removing all data and containers"`
Build *BuildCmd `cmd:"" group:"Cardinal Commands:" help:"Build and package your Cardinal game into production-ready Docker images"`
}
func (*CardinalCmd) Run ¶ added in v1.8.0
func (c *CardinalCmd) Run() error
type DevCmd ¶ added in v1.8.0
type DevCmd struct {
Parent *CardinalCmd `kong:"-"`
Editor bool ` flag:"" help:"Enable Cardinal Editor"`
PrettyLog bool ` flag:"" help:"Run Cardinal with pretty logging" default:"true"`
Context context.Context `kong:"-"`
}
type PurgeCmd ¶ added in v1.8.0
type PurgeCmd struct {
Parent *CardinalCmd `kong:"-"`
}
type RestartCmd ¶ added in v1.8.0
type RestartCmd struct {
Parent *CardinalCmd `kong:"-"`
Detach bool ` flag:"" help:"Run in detached mode"`
Debug bool ` flag:"" help:"Enable debugging"`
}
func (*RestartCmd) Run ¶ added in v1.8.0
func (c *RestartCmd) Run() error
type StartCmd ¶ added in v1.8.0
type StartCmd struct {
Parent *CardinalCmd `kong:"-"`
Detach bool ` flag:"" help:"Run in detached mode"`
LogLevel string ` flag:"" help:"Set the log level for Cardinal"`
Debug bool ` flag:"" help:"Enable delve debugging"`
Telemetry bool ` flag:"" help:"Enable tracing, metrics, and profiling"`
Editor bool ` flag:"" help:"Run Cardinal Editor, useful for prototyping and debugging"`
EditorPort string ` flag:"" help:"Port for Cardinal Editor" default:"auto"`
}
Click to show internal directories.
Click to hide internal directories.