Skip to main content

CLI reference

Usage: tickr-cli [OPTIONS] <COMMAND>

Commands

CommandPurpose
tickr-cli setupConfigure a private Tickr Lite installation
tickr-cli examples run <EXAMPLES>...Run packaged examples and enter the interactive example session
tickr-cli conductorRun the distributed Conductor component
tickr-cli apiRun the distributed API component
tickr-cli executorRun a distributed Executor component
tickr-cli migrateApply and verify selected Data-plane SQL migrations
tickr-liteRun the admitted single-process Tickr Lite formation
tickr-cli helpPrint command help

Distributed formation option

--formation <DISTRIBUTED_FORMATION>

Possible values:

  • all-nats — default when the option is omitted;
  • all-redis — explicit all-Redis formation.

The option precedes the distributed component command:

tickr-cli --formation all-nats conductor
tickr-cli --formation all-redis api

Tickr Lite is a standalone executable, not a distributed formation option:

tickr-lite

Migrations

Usage: tickr-cli migrate [OPTIONS]

--formation <FORMATION>
possible values: distributed, tickr-lite
default: distributed

Examples:

tickr-cli migrate
tickr-cli migrate --formation tickr-lite

Use the matched release executables, profile, SQL configuration, and durable state identity for migration and runtime startup.

Common options

OptionMeaning
-h, --helpPrint help
-V, --versionPrint the executable version