cli

Documentation

Overview

Package cli holds the txco subcommand surface — the developer-facing rule-authoring loop. Subcommands live in their own files (init.go, apply.go, diff.go); this file is just the dispatcher.

The dispatcher is invoked from chassis/main.go before the server-mode config loader, so subcommands can declare their own flag namespaces without colliding with the server's --web-addr et al.

Index

• func Dispatch(args []string, stdout, stderr io.Writer) (status int, ok bool)
• type BuildInfo
• type ResolvedTarget
  • func (t ResolvedTarget) AsClientTarget() client.Target

Functions

func Dispatch

func Dispatch(args []string, stdout, stderr io.Writer) (status int, ok bool)

Dispatch routes a `txco <subcommand> ...` invocation to the right command. Returns ok=true if a subcommand was dispatched (caller should exit with the returned status code) and ok=false if the args don't name a known subcommand (caller should fall through to server-mode boot).

args is typically os.Args; args[0] is the program name, args[1] is the subcommand. `serve` is recognized but treated as a no-op so the server-mode boot can run.

Bare `txco` prints help (Stripe/gcloud-style) — starting the server now requires the explicit `txco serve`. Server-mode flags (e.g. `txco --web-addr=:8080`) still fall through for back-compat.

Types

type BuildInfo

type BuildInfo struct {
	Version        string
	CommitId       string
	BuildTimestamp string
	// InstallMethod is the build origin stamped via ldflag: "source"
	// (Makefile / unstamped dev builds) or "release" (the GitHub release
	// build). The update package refines it at runtime — see
	// chassis/cli/update. Empty is treated as "source".
	InstallMethod string
	// Chassis is the embedded open-core pin for a distribution that wraps
	// the chassis as a dependency (e.g. the txco-saas overlay stamps the
	// core pseudo-version here, while Version/CommitId describe the overlay
	// build itself). Empty for the open-core binary, where Version/CommitId
	// already are the chassis build.
	Chassis string
}

BuildInfo carries the ldflag-injected build identity (set in cmd/txco/main.go, stamped at build time by chassis/Makefile or .github/workflows/release.yml). app.Run assigns Build before calling Dispatch so the help screen + the `version` subcommand can read it without threading it through every signature.

var Build BuildInfo

Build is the process-wide build identity. Zero values are tolerated — the help line is suppressed and the version JSON simply contains empty strings; for real binaries app.Run sets it before any CLI dispatch.

type ResolvedTarget

type ResolvedTarget struct {
	Name    string
	Chassis string
	// ChassisExplicit is true when Chassis came from real config
	// (txco.yaml target / legacy addr), false when it's the
	// synthesized http://localhost:8081 fallback. Lets resolveTarget
	// prefer the signing profile's bound chassis_url over a blind
	// localhost default, without overriding an explicit config.
	ChassisExplicit bool
	User            string
	Pass            string
	Mock            string // "allow" | "deny"
	Operations      map[string]operationConfig
}

ResolvedTarget is what apply / diff / dev consume. It's flat by design: no operation merging or auth lookup happens past this point.

func (ResolvedTarget) AsClientTarget

func (t ResolvedTarget) AsClientTarget() client.Target

AsClientTarget reduces a ResolvedTarget to the subset the admin HTTP client needs (URL + basic auth). Kept separate so the dev/apply code paths can keep all the operation map / mock policy bits without leaking them into the client package.