clicmd

Documentation

Overview

Package clicmd is the server-side registry for CLI subcommands forwarded over the admin API — the "zero-install plugin" path. When `txco <name> ...` is not a built-in (and no local txco-<name> plugin handles it), the CLI POSTs the argv to /v1/cli and the server runs the registered handler for <name>, returning its rendered output + exit code.

The seam is generic and billing-neutral: an overlay self-registers a command from its init() and the product binary activates it with a blank import — the same compile-time pattern as usage.Register / bgservice.Register. Open core registers no commands, so an unknown command 404s and the CLI gracefully falls back to its unknown-subcommand error.

Index

• func Register(name string, h Handler)
• type Handler
  • func Lookup(name string) (Handler, bool)
• type Result

Functions

func Register

func Register(name string, h Handler)

Register adds a command handler. Called from a backend package's init(); the product binary activates it with a blank import. Last registration wins.

Types

type Handler

type Handler func(ctx context.Context, args []string) (Result, error)

Handler runs one forwarded command server-side. args is everything after the command name — for `txco credit grant add acme 5`, name is "credit" and args is ["grant","add","acme","5"]. The endpoint has already enforced super-admin. A returned error is an INTERNAL failure (rendered as HTTP 500); user-facing errors (bad args, not found) should be a Result with a non-zero Exit + Stderr, nil error — so they render like a normal CLI error, not a server fault.

func Lookup

func Lookup(name string) (Handler, bool)

Lookup returns the handler for name, if registered.

type Result

type Result struct {
	Stdout string
	Stderr string
	Exit   int
}

Result is a forwarded command's rendered output plus a process-style exit code. The CLI prints Stdout/Stderr verbatim and exits with Exit.