Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( PosthogAPIKey string SentryDsn string AppVersion string )
These variables are overridden by ldflags during build. Example: go build -ldflags "-X github.com/argus-labs/world-engine/cli/commands/root.PosthogAPIKey=<POSTHOG_API_KEY> -X github.com/argus-labs/world-engine/cli/commands/root.SentryDsn=<SENTRY_DSN> -X github.com/argus-labs/world-engine/cli/commands/root.AppVersion=<VERSION>"
Functions ¶
This section is empty.
Types ¶
type BuildCmd ¶
type BuildCmd struct {
Debug bool `default:"true" help:"Enable debug mode" negatable:""`
Shard string ` help:"Build only the specified shard ID (defaults to all shards in world.toml)"`
Progress phasebox.Progress `` /* 142-byte string literal not displayed */
}
BuildCmd builds Cardinal shard images without starting any containers. Hidden from `world -h` because it exists for deployment CI, not interactive use — `world start` is the supported user flow.
type Cmd ¶
type Cmd struct {
Setup *SetupCmd `cmd:"" group:"Getting Started:" help:"Setup a new World Engine project"`
Docs *DocsCmd `cmd:"" group:"Getting Started:" help:"Open the World CLI documentation"`
Doctor *DoctorCmd `cmd:"" group:"Getting Started:" help:"Check your development environment"`
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"`
Purge *PurgeCmd `cmd:"" group:"Cardinal Commands:" help:"Reset your Cardinal game shard to a clean state by removing all data and containers"`
Reload *ReloadCmd `cmd:"" group:"Cardinal Commands:" help:"Rebuild and roll Cardinal shards in the running cluster"`
Logs *LogsCmd `cmd:"" group:"Cardinal Commands:" help:"View and tail logs for shards + platform components"`
Debug *debugger.Cmd `` /* 137-byte string literal not displayed */
SDK *sdk.Cmd `` /* 148-byte string literal not displayed */
Build *BuildCmd `` /* 162-byte string literal not displayed */
MCP *mcp.Cmd `` /* 162-byte string literal not displayed */
Version kong.VersionFlag `` /* 152-byte string literal not displayed */
Verbose bool `` /* 172-byte string literal not displayed */
}
type LogsCmd ¶
type LogsCmd struct {
Debug bool `help:"Enable debug mode" default:"true" negatable:""`
Env string `help:"Tail a deployed environment instead of the local cluster (e.g. us-west1)"`
Shard []string `help:"Limit to these shards (remote only); repeatable"`
Tail int32 `help:"Historical lines to replay before tailing (remote only)" default:"200"`
Previous bool `help:"Logs from the previous container, for a crashed pod (remote only)"`
}
LogsCmd shows the shard/platform log picker against an already-running cluster — the same picker `world start` drops into after its initial reload. Doesn't bring up the cluster or deploy anything; ENTER tails the highlighted target, 'r' reloads the highlighted instance's shard, ctrl+r does the same but first purges just that instance's state, Ctrl+C exits.
type PurgeCmd ¶
type PurgeCmd struct {
Image bool `help:"Also prune Cardinal shard images + per-reload registry tags. k3d base images are NOT removed."`
}
type ReloadCmd ¶
type ReloadCmd struct {
Instances []string `arg:"" optional:"" help:"Instance IDs to reload; defaults to every instance"`
Debug bool ` help:"Enable debug mode" default:"true" negatable:""`
Purge bool ` help:"Wipe instance state (NATS JetStream) before reload" default:"false" negatable:""`
}
ReloadCmd rebuilds one or more Cardinal shards and rolls them in the already-running local cluster. Inner-loop iteration alternative to `world stop` + `world start`.
Source Files
Directories