commands

package

Go to main page

Versions in this module

v0

v0.10.0

Jun 10, 2026

v0.9.1

Jun 4, 2026

v0.9.0

May 28, 2026

Changes in this version

+ func AuthProviderAddGitHub(ctx *Context, opts struct{ ... }) error

+ func AuthProviderAddOIDC(ctx *Context, opts struct{ ... }) error

+ func RegisterStandalone(ctx *Context, opts RegisterOptions) error

v0.8.0

May 20, 2026

Changes in this version

+ const GroupClient

+ const GroupConfiguring

+ const GroupGettingStarted

+ const GroupHidden

+ const GroupMonitoring

+ const GroupServer

+ var HelpGroupOrder = []string

+ func AppVersions(ctx *Context, opts struct{ ... }) error

+ func AuthProviderAdd(ctx *Context, opts struct{ ... }) error

+ func AuthProviderAddPassword(ctx *Context, opts struct{ ... }) error

+ func AuthProviderList(ctx *Context, opts struct{ ... }) error

+ func AuthProviderRemove(ctx *Context, opts struct{ ... }) error

+ func AuthProviderShow(ctx *Context, opts struct{ ... }) error

+ func DebugAdvertise(ctx *Context, opts struct{ ... }) error

+ func HandleVersionDrift(ctx context.Context, mgr *release.Manager, serviceName string) (bool, error)

+ func MaskValue(value string, sensitive bool) string

+ func PrintRunningVersionDrift(serviceName string, onDisk release.VersionInfo) bool

+ func RenderTopLevelHelp(d *mflags.Dispatcher)

+ func RouteProtect(ctx *Context, opts struct{ ... }) error

+ func RouteUnprotect(ctx *Context, opts struct{ ... }) error

+ func RouteWaf(ctx *Context, opts struct{ ... }) error

type Cmd

+ func (w *Cmd) CommandGroup() string

type CommandOption

+ func WithGroup(group string) CommandOption

+ type LocalEnvDetection struct

+ Additional []LocalEnvVar

+ Available []LocalEnvVar

+ Missing []LocalEnvVar

+ func DetectLocalEnvVars(detectedKeys []string) LocalEnvDetection

+ type LocalEnvVar struct

+ HasValue bool

+ Key string

+ Sensitive bool

+ Source string

+ Value string

type SectionOption

+ func WithSectionGroup(group string) SectionOption

v0.7.1

Apr 22, 2026

v0.7.0

Apr 14, 2026

Changes in this version

+ func AliasList(ctx *Context, opts struct{ ... }) error

+ func AppRestart(ctx *Context, opts struct{ ... }) error

+ func DiskListDeleted(ctx *Context, opts struct{ ... }) error

+ func DiskUndelete(ctx *Context, opts struct{ ... }) error

+ func HelpAlias(ctx *Context, opts helpAliasOpts) error

+ func RunnerInstall(ctx *Context, opts struct{ ... }) error

+ func RunnerRemove(ctx *Context, opts struct{ ... }) error

+ func RunnerServiceStatus(ctx *Context, opts struct{ ... }) error

+ func RunnerStatus(ctx *Context, opts struct{ ... }) error

+ func RunnerTokenCreate(ctx *Context, opts struct{ ... }) error

+ func RunnerTokenList(ctx *Context, opts struct{ ... }) error

+ func RunnerTokenRevoke(ctx *Context, opts struct{ ... }) error

+ func RunnerUninstall(ctx *Context, opts struct{ ... }) error

+ func RunnerUpgrade(ctx *Context, opts struct{ ... }) error

+ func RunnerUpgradeRollback(ctx *Context, opts struct{ ... }) error

type AppCentric

+ func (a *AppCentric) ResolvedDir() string

v0.6.1

Mar 24, 2026

Changes in this version

type FormatOptions

+ JSON bool

v0.6.0

Mar 17, 2026

Changes in this version

+ func DiskBackup(ctx *Context, opts struct{ ... }) (retErr error)

+ func DiskMigrate(ctx *Context, opts struct{ ... }) (retErr error)

+ func DiskRestore(ctx *Context, opts struct{ ... }) (retErr error)

type Cmd

+ func NewHelpCommand(d *mflags.Dispatcher) *Cmd

v0.5.0

Mar 10, 2026

Changes in this version

+ func AuthCIAdd(ctx *Context, opts struct{ ... }) error

+ func AuthCIList(ctx *Context, opts struct{ ... }) error

+ func AuthCIRemove(ctx *Context, opts struct{ ... }) error

+ func ClusterExportAddress(ctx *Context, opts struct{ ... }) error

+ func LogsApp(ctx *Context, opts struct{ ... }) error

+ func LogsBuild(ctx *Context, opts struct{ ... }) error

+ func LogsSandbox(ctx *Context, opts struct{ ... }) error

+ func LogsSystem(ctx *Context, opts struct{ ... }) error

type Cmd

+ func (w *Cmd) Description() string

+ func (w *Cmd) Examples() []mflags.Example

+ func (w *Cmd) RequiredFeature() string

+ type CommandOption func(*Cmd)

+ func WithDescription(desc string) CommandOption

+ func WithExample(example mflags.Example) CommandOption

+ func WithLabsFeature(feature string) CommandOption

+ type SectionOption func(*section)

+ func WithSectionDescription(desc string) SectionOption

v0.4.1

Feb 18, 2026

v0.4.0

Feb 17, 2026

Changes in this version

+ func AddonCreate(ctx *Context, opts struct{ ... }) error

+ func AddonDestroy(ctx *Context, opts struct{ ... }) error

+ func AddonList(ctx *Context, opts struct{ ... }) error

+ func AddonListAvailable(ctx *Context, opts struct{ ... }) error

+ func AddonVariants(ctx *Context, opts struct{ ... }) error

+ func ClusterCurrent(ctx *Context, opts struct{ ... }) error

+ func Rollback(ctx *Context, opts struct{ ... }) error

+ func RouteOidcDisable(ctx *Context, opts struct{ ... }) error

+ func RouteOidcEnable(ctx *Context, opts struct{ ... }) error

+ func RouteOidcShow(ctx *Context, opts struct{ ... }) error

+ func RunnerStart(ctx *Context, opts struct{ ... }) error

type AppCentric

+ func (a *AppCentric) LoadCluster() (*clientconfig.ClusterConfig, string, error)

type Context

+ func (c *Context) Verbose() bool

v0.3.1

Feb 6, 2026

Changes in this version

+ func Admin(ctx *Context, opts struct{ ... }) error

+ func DebugLsvdInfo(ctx *Context, opts struct{ ... }) error

+ func DebugLsvdMetrics(ctx *Context, opts struct{ ... }) error

+ func DebugLsvdMounts(ctx *Context, opts struct{ ... }) error

+ func DebugLsvdVolumes(ctx *Context, opts struct{ ... }) error

+ func DebugOutboardHealth(ctx *Context, opts struct{ ... }) error

+ func RunnerInvite(ctx *Context, opts struct{ ... }) error

+ func RunnerInviteList(ctx *Context, opts struct{ ... }) error

+ func RunnerJoin(ctx *Context, opts struct{ ... }) error

+ func RunnerList(ctx *Context, opts struct{ ... }) error

+ func RunnerRevoke(ctx *Context, opts struct{ ... }) error

+ func ServerLsvd(ctx *Context, opts struct{ ... }) error

v0.3.0

Jan 27, 2026

Changes in this version

+ func DebugBundle(ctx *Context, opts struct{ ... }) error

+ func DeployCancel(ctx *Context, opts struct{ ... }) error

+ func RegisterAll(d *mflags.Dispatcher)

type Cmd

+ func (w *Cmd) FlagSet() *mflags.FlagSet

+ func (w *Cmd) Usage() string

type Context

+ ServerState *ServerState

+ type EnvVarSpec struct

+ FromFile bool

+ FromFile_ string

+ Key string

+ Sensitive bool

+ Value string

+ func ParseEnvVarSpecs(envSpecs, sensitiveSpecs []string) ([]EnvVarSpec, error)

+ type ServerState struct — darwin/amd64, js/wasm, windows/amd64

+ func NewServerState() *ServerState

+ type ServerState struct — linux/amd64

+ Bridge string

+ CC *containerd.Client

+ CPU *metrics.CPUUsage

+ ContainerdSocket string

+ DataPath string

+ HTTPMetrics *metrics.HTTPMetrics

+ IPv4Routable netip.Prefix

+ LogWriter observability.LogWriter

+ Logs *observability.LogReader

+ LogsMaintainer *observability.LogsMaintainer

+ Mem *metrics.MemoryUsage

+ Namespace string

+ NetServ *network.ServiceManager

+ Reader *metrics.VictoriaMetricsReader

+ SandboxMetrics *sandbox.Metrics

+ ServicePrefixes []netip.Prefix

+ StatusMon *observability.StatusMonitor

+ Subnet *netdb.Subnet

+ Tempdir string

+ VictorialogsAddress string

+ VictorialogsTimeout time.Duration

+ VictoriametricsAddress string

+ VictoriametricsTimeout time.Duration

+ Writer *metrics.VictoriaMetricsWriter

+ func (s *ServerState) InitContainerd() error

+ func (s *ServerState) InitLogsMaintainer()

+ func (s *ServerState) InitMetricsReader(log *slog.Logger)

+ func (s *ServerState) InitMetricsWriter(log *slog.Logger)

+ func (s *ServerState) InitNetServ(log *slog.Logger, eac *entityserver_v1alpha.EntityAccessClient)

+ func (s *ServerState) InitSandboxMetrics(log *slog.Logger)

+ func (s *ServerState) InitStatusMonitor(log *slog.Logger)

v0.2.1

Dec 19, 2025

Changes in this version

+ func LoginWithDefaults(ctx *Context) error

v0.2.0

Dec 17, 2025

Changes in this version

+ func AppRun(ctx *Context, opts struct{ ... }) error

+ func DebugNetDBGC(ctx *Context, opts struct{ ... }) error

+ func DebugNetDBList(ctx *Context, opts struct{ ... }) error

+ func DebugNetDBRelease(ctx *Context, opts struct{ ... }) error

+ func DebugNetDBStatus(ctx *Context, opts struct{ ... }) error

+ func Doctor(ctx *Context, opts struct{ ... }) error

+ func DoctorAll(ctx *Context, opts struct{ ... }) error

+ func DoctorApps(ctx *Context, opts struct{ ... }) error

+ func DoctorAuth(ctx *Context, opts struct{ ... }) error

+ func DoctorConfig(ctx *Context, opts struct{ ... }) error

+ func DoctorServer(ctx *Context, opts struct{ ... }) error

v0.1.0

Dec 9, 2025

v0.0.4

Dec 9, 2025

v0.0.3

Dec 8, 2025

Changes in this version

+ func AddClusterInteractive(ctx *Context) error

+ func ServerInstall(ctx *Context, opts struct{ ... }) error — darwin/amd64, js/wasm, windows/amd64

+ func ServerStatus(ctx *Context, opts struct{ ... }) error — darwin/amd64, js/wasm, windows/amd64

+ func ServerUninstall(ctx *Context, opts struct{ ... }) error — darwin/amd64, js/wasm, windows/amd64

v0.0.2

Dec 4, 2025

v0.0.1

Dec 2, 2025

Changes in this version

+ const Stamp

+ var ErrAccessDenied = errors.New("access denied")

+ var ErrAutoConfigFailed = errors.New("auto-configuration failed")

+ var ErrNoAutoConfigNeeded = errors.New("no auto-configuration needed")

+ var ErrNoConfig = errors.New("no cluster config")

+ var Meter = spinner.Spinner

+ func AllCommands() map[string]cli.CommandFactory

+ func App(ctx *Context, opts struct{ ... }) error

+ func AppDelete(ctx *Context, opts struct{ ... }) error

+ func AppHistory(ctx *Context, opts struct{ ... }) error

+ func AppList(ctx *Context, opts struct{ ... }) error

+ func AppStatus(ctx *Context, opts struct{ ... }) error

+ func Apps(ctx *Context, opts struct{ ... }) error

+ func AuthGenerate(ctx *Context, opts struct{ ... }) error

+ func CheckIfUpgradeNeeded(ctx context.Context, targetVersion string, force bool, ...) (bool, error)

+ func CheckVersionStatus(ctx context.Context, targetVersion string, mgrOpts *release.ManagerOptions) (current, latest release.VersionInfo, err error)

+ func Cluster(ctx *Context, opts struct{ ... }) error

+ func ClusterAdd(ctx *Context, opts struct{ ... }) error

+ func ClusterList(ctx *Context, opts struct{ ... }) error

+ func ClusterRemove(ctx *Context, opts struct{ ... }) error

+ func ClusterSwitch(ctx *Context, opts struct{ ... }) error

+ func Colors(ctx *Context, opts struct{}) error

+ func ConfigBind(ctx *Context, opts struct{ ... }) error

+ func ConfigInfo(ctx *Context, opts struct{ ... }) error

+ func ConfigLoad(ctx *Context, opts struct{ ... }) error

+ func ConfigRemove(ctx *Context, opts struct{ ... }) error

+ func ConfigSetActive(ctx *Context, opts struct{ ... }) error

+ func Console(ctx *Context, opts struct{ ... }) error

+ func CtrNuke(c *Context, opts struct{ ... }) error

+ func DebugConnection(ctx *Context, opts struct{ ... }) error

+ func DebugCtr(ctx *Context, opts struct{ ... }) error

+ func DebugDiskCreate(ctx *Context, opts struct{ ... }) error

+ func DebugDiskDelete(ctx *Context, opts struct{ ... }) error

+ func DebugDiskLease(ctx *Context, opts struct{ ... }) error

+ func DebugDiskLeaseDelete(ctx *Context, opts struct{ ... }) error

+ func DebugDiskLeaseList(ctx *Context, opts struct{ ... }) error

+ func DebugDiskLeaseRelease(ctx *Context, opts struct{ ... }) error

+ func DebugDiskLeaseStatus(ctx *Context, opts struct{ ... }) error

+ func DebugDiskList(ctx *Context, opts struct{ ... }) error

+ func DebugDiskMounts(ctx *Context, opts struct{}) error

+ func DebugDiskStatus(ctx *Context, opts struct{ ... }) error

+ func DebugRBAC(ctx *Context, opts struct{ ... }) error

+ func DebugRBACTest(ctx *Context, opts struct{ ... }) error

+ func DebugReindex(ctx *Context, opts struct{ ... }) error

+ func Deploy(ctx *Context, opts struct{ ... }) error

+ func DialStdio(ctx *Context, opts struct{ ... }) error

+ func DownloadRelease(ctx *Context, opts struct{ ... }) error

+ func EntityCheck(ctx *Context, opts struct{ ... }) error

+ func EntityCreate(ctx *Context, opts struct{ ... }) error

+ func EntityDelete(ctx *Context, opts struct{ ... }) error

+ func EntityEnsure(ctx *Context, opts struct{ ... }) error

+ func EntityGet(ctx *Context, opts struct{ ... }) error

+ func EntityList(ctx *Context, opts struct{ ... }) error

+ func EntityPatch(ctx *Context, opts struct{ ... }) error

+ func EntityPut(ctx *Context, opts struct{ ... }) error

+ func EntityReplace(ctx *Context, opts struct{ ... }) error

+ func EnvDelete(ctx *Context, opts struct{ ... }) error

+ func EnvGet(ctx *Context, opts struct{ ... }) error

+ func EnvList(ctx *Context, opts struct{ ... }) error

+ func EnvSet(ctx *Context, opts struct{ ... }) error

+ func ExpandPath(path string) string

+ func FindReleasePath() string

+ func HiddenCommands() []string

+ func Init(ctx *Context, opts struct{ ... }) error

+ func Login(ctx *Context, opts struct{ ... }) error

+ func Logout(ctx *Context, opts struct{ ... }) error

+ func Logs(ctx *Context, opts struct{ ... }) error

+ func MinuteLabeler(i int, v float64) string

+ func PerformDownloadRelease(ctx *Context, opts DownloadReleaseOptions) error

+ func PrintJSON(data any) error

+ func PrintJSONTo(w io.Writer, data any) error

+ func PrintUpgradeSuccess(ctx context.Context, oldVersion release.VersionInfo, commandType string, ...)

+ func PrintVersionComparison(current, latest release.VersionInfo)

+ func Register(ctx *Context, opts RegisterOptions) error

+ func RegisterStatus(ctx *Context, opts struct{ ... }) error

+ func Route(ctx *Context, opts struct{ ... }) error

+ func RouteList(ctx *Context, opts struct{ ... }) error

+ func RouteRemove(ctx *Context, opts struct{ ... }) error

+ func RouteSet(ctx *Context, opts struct{ ... }) error

+ func RouteSetDefault(ctx *Context, opts struct{ ... }) error

+ func RouteShow(ctx *Context, opts struct{ ... }) error

+ func RouteUnsetDefault(ctx *Context, opts struct{ ... }) error

+ func SandboxCreate(ctx *Context, opts struct{ ... }) error

+ func SandboxDelete(ctx *Context, opts struct{ ... }) error

+ func SandboxExec(ctx *Context, opts struct{ ... }) error

+ func SandboxList(ctx *Context, opts struct{ ... }) error

+ func SandboxMetrics(ctx *Context, opts struct{ ... }) error

+ func SandboxPoolList(ctx *Context, opts struct{ ... }) error

+ func SandboxPoolSetDesired(ctx *Context, opts struct{ ... }) error

+ func SandboxStop(ctx *Context, opts struct{ ... }) error

+ func Section(name, desc, help string) cli.Command

+ func SelectCluster(ctx *Context, title string, clusters []string, activeCluster string, ...) (string, error)

+ func Server(ctx *Context, opts serverconfig.CLIFlags) error — linux/amd64

+ func Server(ctx *Context, opts struct{}) error — darwin/amd64

+ func ServerConfigGenerate(ctx *Context, opts struct{ ... }) error

+ func ServerConfigValidate(ctx *Context, opts struct{ ... }) error

+ func ServerInstall(ctx *Context, opts struct{ ... }) error — linux/amd64

+ func ServerInstallDocker(ctx *Context, opts struct{ ... }) error

+ func ServerStatus(ctx *Context, opts struct{ ... }) error — linux/amd64

+ func ServerStatusDocker(ctx *Context, opts struct{ ... }) error

+ func ServerUninstall(ctx *Context, opts struct{ ... }) error — linux/amd64

+ func ServerUninstallDocker(ctx *Context, opts struct{ ... }) error

+ func ServerUpgrade(ctx *Context, opts struct{ ... }) error

+ func ServerUpgradeRollback(ctx *Context, opts struct{ ... }) error

+ func Set(ctx *Context, opts struct{ ... }) error

+ func TestLoad(ctx *Context, opts struct{ ... }) error

+ func Upgrade(ctx *Context, opts struct{ ... }) error

+ func Version(ctx *Context, opts VersionOptions) error

+ func Whoami(ctx *Context, opts struct{ ... }) error

+ type AppCentric struct

+ App string

+ Dir string

+ func (a *AppCentric) Validate(glbl *GlobalFlags) error

+ type BeginKeyRegistrationRequest struct

+ KeyType string

+ Name string

+ PublicKey string

+ type BeginKeyRegistrationResponse struct

+ Challenge string

+ Envelope string

+ type ClusterResponse struct

+ APIAddresses []string

+ CACertFingerprint string

+ Description string

+ Name string

+ OrganizationName string

+ OrganizationXID string

+ Tags map[string]interface{}

+ XID string

+ type Cmd struct

+ func Infer(name, syn string, f interface{}) *Cmd

+ func (w *Cmd) Help() string

+ func (w *Cmd) Invoke(args ...string) error

+ func (w *Cmd) ReadOptions(path string) error

+ func (w *Cmd) Run(args []string) int

+ func (w *Cmd) Synopsis() string

+ type CommandOutput struct

+ Stderr bytes.Buffer

+ Stdout bytes.Buffer

+ func RunCommand(f any, args ...string) (*CommandOutput, error)

+ type CompleteKeyRegistrationRequest struct

+ Envelope string

+ Signature string

+ type ConfigCentric struct

+ Cluster string

+ Config string

+ func (c *ConfigCentric) LoadCluster() (*clientconfig.ClusterConfig, string, error)

+ func (c *ConfigCentric) LoadConfig() (*clientconfig.Config, error)

+ func (c *ConfigCentric) SaveConfig() error

+ type Context struct

+ Client *asm.Registry

+ ClientConfig *clientconfig.Config

+ ClusterConfig *clientconfig.ClusterConfig

+ ClusterName string

+ Config struct{ ... }

+ Log *slog.Logger

+ Server *asm.Registry

+ Stderr io.Writer

+ Stdout io.Writer

+ UILog *slog.Logger

+ func (c *Context) Begin(format string, args ...interface{})

+ func (c *Context) Close() error

+ func (c *Context) Completed(format string, args ...interface{})

+ func (c *Context) DisplayTable(headers []string, rows [][]string)

+ func (c *Context) DisplayTableTemplate(template string, items []any)

+ func (c *Context) Info(format string, args ...interface{})

+ func (c *Context) Level() slog.Level

+ func (c *Context) Printf(format string, args ...interface{})

+ func (c *Context) RPCClient(name string) (*rpc.NetworkClient, error)

+ func (c *Context) SetExitCode(code int)

+ func (c *Context) Warn(format string, args ...interface{})

+ type DebugAuthResponse struct

+ AuthMethod string

+ Identity string

+ Message string

+ ServerVersion string

+ Success bool

+ UserInfo map[string]string

+ type DeviceFlowExchangeResponse struct

+ AccessToken string

+ Error string

+ ErrorDescription string

+ ExpiresIn int

+ Status string

+ TokenType string

+ type DeviceFlowInitResponse struct

+ DeviceCode string

+ ExpiresIn int

+ PollingInterval int

+ UserCode string

+ VerificationURL string

+ VerificationURLComplete string

+ type DownloadReleaseOptions struct

+ Branch string

+ Force bool

+ Global bool

+ Output string

+ type ErrExitCode int

+ func (e ErrExitCode) Error() string

+ type FormatOptions struct

+ Format string

+ func (f *FormatOptions) IsJSON() bool

+ type GlobalFlags struct

+ Options string

+ ServerAddress string

+ Verbose []bool

+ type KeyRegistrationResponse struct

+ CreatedAt string

+ Fingerprint string

+ ID string

+ Name string

+ type Model struct

+ func (m Model) Init() tea.Cmd

+ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

+ func (m Model) View() string

+ type OptsValidate interface

+ Validate func(glbl *GlobalFlags) error

+ type RegisterOptions struct

+ CloudURL string

+ ClusterName string

+ OutputDir string

+ Tags map[string]string

+ type SelectionModel struct

+ Cancelled bool

+ Footer string

+ ItemMarker func(item string) string

+ ItemStyle func(item string) lipgloss.Style

+ Items []string

+ Selected string

+ Title string

+ func (m *SelectionModel) Init() tea.Cmd

+ func (m *SelectionModel) SetCursor(index int)

+ func (m *SelectionModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

+ func (m *SelectionModel) View() string

+ type TickMsg struct

+ Time time.Time

+ type VersionOptions struct

+ Deps bool

+ Format string

v0.0.0-test.1

Nov 17, 2025

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL