Skip to main content

UIS CLI Reference

The ./uis command manages the UIS provision-host container and all services within it. Commands are organized into host-level (managing the container) and service-level (managing Kubernetes services inside the container).

Container Management

These commands run on the host machine and manage the UIS container.

CommandDescription
./uis startStart the UIS provision-host container
./uis stopStop the container
./uis restartRestart the container
./uis containerShow container status
./uis shellOpen interactive bash shell in the container
./uis exec <command>Execute a command inside the container
./uis logs [--tail N]Show container logs (default: last 50 lines)
./uis buildBuild the container image locally as uis-provision-host:local

Service Management

Discovery

CommandDescription
./uis listList all services with deployment status
./uis list --category <id>Filter by category (e.g., DATABASES, OBSERVABILITY)
./uis list --allShow all services including disabled
./uis statusShow deployed services health and cluster context
./uis categoriesList all service categories

Deploy and Undeploy

CommandDescription
./uis deployDeploy all enabled/autostart services
./uis deploy <service-id>Deploy a specific service (auto-enables it)
./uis undeploy <service-id>Remove a service from the cluster

Autostart Configuration

Services can be marked for automatic deployment.

CommandDescription
./uis enable <service-id>Add service to autostart (deploys on next ./uis deploy)
./uis disable <service-id>Remove from autostart (does not undeploy)
./uis list-enabledShow all services in autostart configuration
./uis syncAuto-enable all currently deployed services

Verification

CommandDescription
./uis verify <service-id>Run service-specific verification checks

Stack Management

Stacks are pre-configured groups of related services deployed together.

CommandDescription
./uis stacksList all available stacks
./uis stack info <stack-id>Show stack details (components, dependencies)
./uis stack install <stack-id>Install all services in a stack in order
./uis stack install <stack-id> --skip-optionalSkip optional services
./uis stack remove <stack-id>Remove all services in a stack

Available stacks: observability, ai-local, analytics

Secrets Management

CommandDescription
./uis secrets initCreate .uis.secrets/ directory with templates
./uis secrets statusShow which secrets are configured vs missing
./uis secrets editOpen secrets config in editor
./uis secrets generateGenerate Kubernetes secrets from templates
./uis secrets applyApply generated secrets to the cluster
./uis secrets validateValidate secrets config and check required values

Testing

CommandDescription
./uis test-allDeploy and undeploy all services (full integration test)
./uis test-all --dry-runShow test plan without executing
./uis test-all --cleanUndeploy everything first, then run tests
./uis test-all --only <svc> [svc...]Test only specified services and their dependencies

Service-Specific Commands

Tailscale

CommandDescription
./uis tailscale expose <service-id>Expose a service via Tailscale Funnel
./uis tailscale unexpose <service-id>Remove service from Tailscale Funnel
./uis tailscale verifyCheck Tailscale secrets, API, devices, and operator

Cloudflare

CommandDescription
./uis cloudflare verifyCheck tunnel network and pod status
./uis cloudflare teardownRemove tunnel (shows manual dashboard steps)

ArgoCD

CommandDescription
./uis argocd register <name> <repo-url>Register a GitHub repo as ArgoCD application. Name is used as namespace, repo-url must be full HTTPS URL
./uis argocd remove <name>Remove an ArgoCD application and its namespace
./uis argocd listList registered ArgoCD applications with health and sync status
./uis argocd verifyRun ArgoCD health checks

Host Configuration

Manage configurations for different deployment targets.

CommandDescription
./uis host addList available host templates
./uis host add <template-id>Add a host configuration from template
./uis host listList configured hosts with status

Other Commands

CommandDescription
./uis initFirst-time setup wizard (cluster type, domain, project name)
./uis setupInteractive TUI menu for browsing and deploying services
./uis tools listList optional tools with installation status
./uis tools install <tool-id>Install an optional tool (aws-cli, azure-cli, etc.)
./uis docs generate [dir]Generate JSON data files for website documentation
./uis versionShow UIS version
./uis helpShow help

Environment Variables

VariablePurposeDefault
UIS_IMAGEOverride container imageghcr.io/helpers-no/uis-provision-host:latest
UIS_KUBECONFIG_DIROverride kubeconfig directory$HOME/.kube