Skip to content
CLI reference

CLI reference

The tide binary is the single control surface for the platform. Everything on this page was taken from its --help output. Run tide <command> --help for the authoritative text on your build.

Configuration

Resolution order (root.go, initViper): ./tide.yaml, then ~/.tide.yaml, then TIDE_* environment variables (a . in a key becomes _), then flags. A missing config file is fine.

Global flags

FlagDefaultMeaning
--modelocallocal (multipass k0s, dev) or onhost (single-node k0s on this host)
--face-repo../facepath to the sibling FACE repo
--pulse-repo../pulsepath to the sibling PULSE repo
--control-ctxface-controlshared control-plane VM and kube context (local mode)
--kustomize./bin/kustomizepath to the kustomize binary
--kubectlkubectlkubectl binary (in onhost mode outside a pod it becomes k0s)
--github-repononeowner/name for instance-request issues (or TIDE_GITHUB_REPO)
--github-labelinstance-requestissue label that marks an instance request
--console-urlnone, on purposeRunink TIDE console base URL for session-run reporting (or TIDE_CONSOLE_URL / console_url)
--image-pull-policynoneoverride every imagePullPolicy the deploy applies: Always, IfNotPresent or Never (or TIDE_IMAGE_PULL_POLICY)
--with-monitoringfalsealso apply the shared inference monitoring stack (needs the Prometheus Operator)

--console-url has no default because TIDE is deployed per client, each with its own console. Empty means “don’t report”: runs still record locally and tide session sync delivers them later.

Command tree

Local development

CommandWhat it does
tide dev up [face|pulse|all]Start the dev stack (default: all)
tide dev secure [face|pulse|all]Start the dev stack plus the single mTLS SNI gateway (unprivileged port)
tide dev downStop everything (backends, frontends, inference, gateway, mesh pipes)
tide dev hosts [--remove]Map *.runink.org.local → 127.0.0.1 and grant the gateway :443 (one-time sudo)
tide dev flutter <face|pulse|core>Hot-reload one Flutter UI against a backend. --device chrome|web-server, --endpoint, --port (defaults 5551 face / 5552 pulse / 5553 core)
tide dev frontendLaunch only the local Flutter UIs pointed at real deployed instances. --face-url, --pulse-url (or TIDE_REMOTE_FACE_URL / TIDE_REMOTE_PULSE_URL)
tide app build|flutter|generate|proto|test <name>Per-app dev tasks: build the Go backend, build and stage the Flutter web bundle, proto + build + test, regenerate protobuf (buf), run backend tests + flutter analyze

Cluster and deploy

CommandWhat it does
tide cluster up|status|shell NAME|models|import VM IMG...|down|rmLocal multipass k0s lifecycle (alias clusters). models bind-mounts host GGUF dirs into the VMs; import loads images into a VM’s k0s
tide deploy platformProvision + mesh CA + CRDs + the TIDE operator (no app instances)
tide deploy face / tide deploy pulseDeploy one app instance
tide deploy allPlatform + FACE + PULSE
tide deploy downTear down the overlays (local: stop VMs)
tide build ambassadorBuild the shared static mTLS-proxy image
tide build operator <runink|pulse|core>Build an operator image (+ the shared ambassador)
tide build app <face|pulse>Build an app’s images from its sibling repo
tide build inference-activatorBuild the scale-to-zero inference front-door image
tide bump-fleet-image <app> <sha>Bump the image reference in a k0s-fleet overlay
tide mesh ca [--namespace NS]Mint the shared mesh CA; with --namespace, distribute it to that namespace as a Secret
tide node dedicate --node N --app face|pulse [--tenant T]Dedicate a node to one app (label + taint)
tide gitops renderRender every GitOps kustomization offline
tide local up|downInstall or remove the local suite (Calico, KEDA, Knative) on a fresh cluster with no CNI. Never on a cluster that already has one. (Its --help text still names Argo, which was removed.)
tide statusShow the reconciling desired state (platform + both app instances)
tide smokeSecurity-surface smoke test (mesh CA + rotating-mTLS ambassador)
tide dns syncPoint endpoint hostnames at the edge IP via Namecheap (get → merge → set). --domain, --host (repeatable), --ip, --ttl (min 60), --dry-run
tide build app builds local podman images (localhost/…). The images the cluster runs are built in the cluster. See CI Workflows.

Base images

tide images list|mirror|preflight handles the sovereign base-image mirror. The declared set is the base-image manifest.

Flag (all subcommands)DefaultMeaning
--filethe base-image manifestthe declared base-image set
--ipv4trueforce IPv4 for upstream pulls
--jsonfalsemachine-readable output
--onlynonerestrict to these images (repeatable)
--registrythe set’s owndestination registry override
--timeout30m0sper-request timeout

mirror adds --dry-run and --force. preflight reports which declared images are absent from the registry at the pinned digest and exits non-zero.

Instances and access

CommandWhat it does
tide instance requestOpen a GitHub issue requesting a new instance. Flags: --app, --tenant, --namespace (default tide-system), --role, --image, --replicas, --compute-units, --tag k=v, --user email[:role] (role admin|writer|reader)
tide instance list [--issues]List reconciled ClientInstances, or open requests with --issues
tide instance statusShow reconciled ClientInstances on the cluster
tide instance reconcileProvision instance-request issues and apply user-request grants, then report back
tide instance add-userOpen an issue granting users access to an existing instance: --instance or --app/--tenant, --namespace, --user email[:role] (default role reader)

Data connections

tide connection register <manifest> registers data-source connections into TIDE’s console registry from a committed manifest. Flags: --dry-run, --adopt-drift, --rotate-credentials. It authenticates with a console session from the environment only. Full guide: Connections.

Security and compliance

CommandWhat it does
tide scan [repo...]govulncheck across repos. --fix applies reachable-CVE bumps (go get @fixed → tidy → build-verify), --json, --repo (repeatable), --timeout (default 10m)
tide scan-sweepscan --fix across platform repos. --owner, --repos, --branch (default security/auto-update). No workflow calls it today
tide security scangovulncheck + gosec per Go module per root, emitting SARIF. --roots, --sarif-dir
tide security gateRatchet the gosec SARIF against the committed baseline; fail on new findings or new coverage holes. --baseline-dir, --gate-severity (default MEDIUM), --stale-days (default 90), --update
tide security reportAggregate SARIF into a report with the NIST SSDF mapping
tide security autoupdateAuto-update vulnerable dependencies
tide compliance gateDeterministic control checks over a repo; non-zero exit on findings. --repo, --changed-files, --format text|md|json, --summary
tide compliance inventoryRecompute the audit-emitter inventory (--write updates the policy)

Coding agent

CommandWhat it does
tide auth login|logout|statusGitHub Device Flow sign-in. login takes --force and --no-browser
tide session startStart a new coding session
tide session resume <id>Resume a persisted session with a new instruction
tide session listList persisted sessions
tide session serveRun queued session instructions from the TIDE console on this machine
tide session syncRe-send pending session reports to the console

The session flags are covered in Coding sessions.

Install medium, wizard and Marketplace

CommandWhat it does
tide guide-bundle build|sign BUNDLE|verify BUNDLE [SIG]|keygen|sourceBuild and sign TIDE’s install guide as a private guide bundle
tide wizardInstall Runink applications on a River node and create their admin logins. --serve runs the graphical wizard on a loopback-only page opened with a one-time link; --answers runs scripted
tide wizard status|skipShow what was installed; remove the first-boot login hint
tide marketplace readyExit 0 once every app of the golden answers file is installed, healthy and answering through the edge
tide marketplace admin-credentials show|deliverPrint the production admin logins over SSH, or write them as a new Secret Manager version
tide marketplace secret-accessRead the Secret Manager secret an instance attribute names into a 0600 file on tmpfs

Selected tide wizard flags: --apps (from face,pulse,luna,forge; TIDE is implied), --role server|runner, --offline, --online, --payloads, --passphrase-file, --state (default /etc/runink/wizard-state.json), --dry-run (runs against an in-memory fake node), --listen (loopback only; non-loopback is refused), --firstboot, --installation-admin, --admin (default on), --admin-user, --luna-owner-email.

Platform operations

Each line is the command’s own --help summary. Run tide <command> --help for its subcommands and flags.

CommandWhat it does
tide payloadBuild the private stick’s payloads: per-app images, app bundles, and the no-reuse guard
tide modelsThe Runink Server’s model set: check the lock, pin gated rows, convert a UQFF once
tide mqttThe Runink Server MQTT broker: device certificates
tide evidenceCheck release-evidence documents (runink.release-evidence/1): validate, lint, public-view
tide review-triggerKick the TIDE review sweep unless one is already waiting
tide registry-keeperKeep the node-local registry and the node’s disk inside their budget
tide zfs-janitorThe disk steward: observe the node’s ZFS pool, reason, and reclaim on a gated allowlist
tide snapshotWork with the committed sibling snapshots
tide lintRepository lints (shell-ratchet: no new shell; the list only shrinks)
tide renameThe one cut-over to the TIDE object names: copy, stop, swap, apply, verify, retire (dry-run unless --apply)
tide migrate-namespaceMove FACE from its legacy namespace to face-system, one step at a time (dry-run unless --apply)
tide benchAcceptance benchmarks against a running stack (p50/p95 per phase)

Command-name quick index

app · auth · bench · build · bump-fleet-image · cluster · completion · compliance · connection · deploy · dev · dns · evidence · gitops · guide-bundle · images · instance · lint · local · marketplace · mesh · migrate-namespace · models · mqtt · node · payload · registry-keeper · rename · review-trigger · scan · scan-sweep · security · session · smoke · snapshot · status · wizard · zfs-janitor