CLI Reference
Global Options
Section titled “Global Options”| Flag | Description |
|---|---|
--host <addr> | Server address (default: localhost:9000) |
--namespace <name> | Namespace for operations (default: default) |
--timeout <ms> | Operation timeout in milliseconds |
--format <fmt> | Output format: text, json |
--debug | Enable debug output |
Server
Section titled “Server”flo server start
Section titled “flo server start”Start a Flo server.
flo server start [options]| Flag | Description | Default |
|---|---|---|
-c, --config <path> | Config file path | flo.toml |
--port <port> | Client protocol port | 9000 |
--data-dir <path> | Data directory | ./data |
--shard-count <n> | Number of shard threads | CPU count |
--node-id <id> | Unique node identifier | auto |
--seeds <addrs> | Cluster seed addresses | — |
flo server status
Section titled “flo server status”Show server status and health.
flo server statusflo kv set
Section titled “flo kv set”Set a key-value pair.
flo kv set <key> <value> [options]| Flag | Description |
|---|---|
--ttl <seconds> | Time-to-live |
--if-not-exists | Only set if key doesn’t exist |
--cas <version> | Compare-and-swap version |
flo kv get
Section titled “flo kv get”Get a value by key.
flo kv get <key> [options]| Flag | Description |
|---|---|
--block <ms> | Block until key appears |
flo kv delete
Section titled “flo kv delete”Delete a key.
flo kv delete <key>flo kv list
Section titled “flo kv list”List keys by prefix.
flo kv list [prefix] [options]| Flag | Description |
|---|---|
--limit <n> | Maximum number of keys |
--keys-only | Only return keys, not values |
flo kv history
Section titled “flo kv history”Show version history for a key.
flo kv history <key> [options]| Flag | Description |
|---|---|
--limit <n> | Maximum versions to return |
Streams
Section titled “Streams”flo stream create
Section titled “flo stream create”Create a stream.
flo stream create <name> [options]| Flag | Description |
|---|---|
--retention <duration> | Retention period (e.g., 7d, 24h) |
--max-size <bytes> | Maximum stream size |
flo stream append
Section titled “flo stream append”Append a record to a stream.
flo stream append <stream> <data>flo stream read
Section titled “flo stream read”Read records from a stream.
flo stream read <stream> [options]| Flag | Description |
|---|---|
--offset <n> | Start offset |
--count <n> | Number of records |
--follow | Follow mode (block for new records) |
flo stream info
Section titled “flo stream info”Show stream metadata.
flo stream info <stream>flo stream group
Section titled “flo stream group”Manage consumer groups.
flo stream group create <stream> <group>flo stream group read <stream> <group> <consumer> [--count <n>]flo stream group ack <stream> <group> <offsets...>flo stream group status <stream> <group>Queues
Section titled “Queues”flo queue enqueue
Section titled “flo queue enqueue”Add a message to a queue.
flo queue enqueue <queue> <data> [options]| Flag | Description |
|---|---|
--priority <n> | Message priority (higher = sooner) |
--delay <ms> | Delivery delay in milliseconds |
--dedup-key <key> | Deduplication key |
flo queue dequeue
Section titled “flo queue dequeue”Dequeue messages.
flo queue dequeue <queue> [options]| Flag | Description |
|---|---|
--count <n> | Number of messages (default: 1) |
--block <ms> | Block until messages available |
--visibility <ms> | Visibility timeout for leased messages |
flo queue ack
Section titled “flo queue ack”Acknowledge processed messages.
flo queue ack <queue> <sequence...>flo queue nack
Section titled “flo queue nack”Negative acknowledge (requeue or send to DLQ).
flo queue nack <queue> <sequence...> [options]| Flag | Description |
|---|---|
--dlq | Send to dead-letter queue |
flo queue peek
Section titled “flo queue peek”Peek at messages without leasing.
flo queue peek <queue> [--count <n>]flo queue dlq
Section titled “flo queue dlq”Manage dead-letter queue.
flo queue dlq list <queue> [--count <n>]flo queue dlq requeue <queue> <sequence...>flo queue dlq purge <queue>Time-Series
Section titled “Time-Series”flo ts write
Section titled “flo ts write”Write a data point using InfluxDB line protocol.
flo ts write <measurement> <tags> <fields>Examples:
flo ts write cpu host=web-01 usage=82.5flo ts write temperature region=us-east,sensor=a1 value=23.4flo ts query
Section titled “flo ts query”Run a FloQL query.
flo ts query "<query>"Examples:
flo ts query "cpu{host=web-01}[1h] | avg(5m)"flo ts query "temperature{region=us-east}[24h] | max(1h)"Actions
Section titled “Actions”flo action register
Section titled “flo action register”Register an action type.
flo action register <name> [options]| Flag | Description |
|---|---|
--wasm <path> | WASM module path |
--timeout <ms> | Execution timeout |
--max-retries <n> | Maximum retry count |
flo action invoke
Section titled “flo action invoke”Invoke an action.
flo action invoke <name> [data] [options]| Flag | Description |
|---|---|
--idempotency-key <key> | Dedup key for at-most-once |
--priority <n> | Execution priority |
--wait | Wait for completion |
flo action status
Section titled “flo action status”Check action execution status.
flo action status <run-id>Workflows
Section titled “Workflows”flo workflow create
Section titled “flo workflow create”Create a workflow from a YAML definition.
flo workflow create -f <file.yaml>flo workflow start
Section titled “flo workflow start”Start a workflow execution.
flo workflow start <name> [data]flo workflow status
Section titled “flo workflow status”Check workflow execution status.
flo workflow status <execution-id>flo workflow signal
Section titled “flo workflow signal”Send a signal to a running workflow.
flo workflow signal <execution-id> <signal-name> [data]Processing
Section titled “Processing”flo processing submit
Section titled “flo processing submit”Submit a stream processing job.
flo processing submit -f <job.yaml>flo processing status
Section titled “flo processing status”Check job status.
flo processing status <job-id>flo processing stop
Section titled “flo processing stop”Stop a running job.
flo processing stop <job-id>Cluster
Section titled “Cluster”flo cluster status
Section titled “flo cluster status”Show cluster membership and partition distribution.
flo cluster statusflo cluster rebalance
Section titled “flo cluster rebalance”Trigger partition rebalancing.
flo cluster rebalance