teacmd

Documentation

Index

• Constants
• func CheckDependenciesCmd(deps []dependency.Dependency) tea.Cmd
• func DockerPurge() error
• func DockerRestart(cfg *config.Config, services []DockerService) error
• func DockerStart(cfg *config.Config, services []DockerService) error
• func DockerStartAll(cfg *config.Config) error
• func DockerStop(services []DockerService) error
• func DockerStopAll() error
• func GitCloneCmd(url string, targetDir string, initMsg string) error
• func PrettyPrintMissingDependency(depStatus []DependencyStatus) string
• func PrintDependencyStatus(depStatus []DependencyStatus) (string, string)
• func SetupCardinalEditor(rootDir string, gameDir string) error
• type Asset
• type CheckDependenciesMsg
• type DependencyStatus
• type DockerService
• type GitCloneFinishMsg
• type Release

Constants

const (
	TargetEditorDir = ".editor"
)

Functions

func CheckDependenciesCmd

func CheckDependenciesCmd(deps []dependency.Dependency) tea.Cmd

CheckDependenciesCmd Iterate through required dependencies and check if they are installed. Dispatch CheckDependenciesMsg if any dependency is missing.

func DockerPurge

func DockerPurge() error

DockerPurge stops and deletes all docker containers and data volumes This will completely wipe the state, if you only want to stop the containers, use DockerStop

func DockerRestart

func DockerRestart(cfg *config.Config, services []DockerService) error

DockerRestart restarts a given docker container by name, rebuilds the image if `build` is true

func DockerStart

func DockerStart(cfg *config.Config, services []DockerService) error

DockerStart starts a given docker container by name. Rebuilds the image if `build` is true Runs in detach mode if `detach` is true Runs with the debug docker compose, if `debug` is true

func DockerStartAll

func DockerStartAll(cfg *config.Config) error

DockerStartAll starts both cardinal and nakama

func DockerStop

func DockerStop(services []DockerService) error

DockerStop stops running specified docker containers (does not remove volumes). If you want to reset all the services state, use DockerPurge

func DockerStopAll

func DockerStopAll() error

DockerStopAll stops all running docker containers (does not remove volumes).

func GitCloneCmd

func GitCloneCmd(url string, targetDir string, initMsg string) error

func PrettyPrintMissingDependency

func PrettyPrintMissingDependency(depStatus []DependencyStatus) string

func PrintDependencyStatus

func PrintDependencyStatus(depStatus []DependencyStatus) (string, string)

PrintDependencyStatus Return a string with dependency status list and help messages.

func SetupCardinalEditor

func SetupCardinalEditor(rootDir string, gameDir string) error

Types

type Asset

type Asset struct {
	BrowserDownloadURL string `json:"browser_download_url"`
}

type CheckDependenciesMsg

type CheckDependenciesMsg struct {
	Err       error
	DepStatus []DependencyStatus
}

type DependencyStatus

type DependencyStatus struct {
	dependency.Dependency
	IsInstalled bool
}

type DockerService

type DockerService string

const (
	DockerServiceCardinal      DockerService = "cardinal"
	DockerServiceNakama        DockerService = "nakama"
	DockerServiceNakamaDB      DockerService = "nakama-db"
	DockerServiceRedis         DockerService = "redis"
	DockerServiceEVM           DockerService = "evm"
	DockerServiceDA            DockerService = "celestia-devnet"
	DockerServiceCardinalDebug DockerService = "cardinal-debug"
)

type GitCloneFinishMsg

type GitCloneFinishMsg struct {
	Err error
}

type Release

type Release struct {
	Name   string  `json:"name"`
	Assets []Asset `json:"assets"`
}