ProductDocumentationExamplesBlogRoadmapGitHubGet Started
Available

CLI Overview

The krishiv binary, subcommands, global flags, and routing to remote coordinators.

The krishiv binary is the canonical user interface for everything that does not need an SDK. It handles one-shot SQL, continuous streaming jobs, pipeline projects, state inspection, savepoints, and the lifecycle of local and bare-metal clusters.

Discovering commands

krishiv --help
krishiv help sql            # topic-scoped help
krishiv help stream
krishiv help cluster

Global flags

Flag / envEffect
-c, --coordinator <URL> / KRISHIV_COORDINATORRoute state, savepoint, restore, checkpoints commands to a remote coordinator.
-V, --versionPrint version and exit.
-h, --helpPrint help and exit.
KRISHIV_PRODUCTIONFail-closed on unsafe overrides. See Auth & Security.

Routing a command to a remote coordinator

Several commands (state, savepoint, restore, checkpoints) can run against either the embedded local runtime or a remote coordinator. Pick the target with -c or KRISHIV_COORDINATOR:

# Local (embedded)
krishiv savepoint --job my-pipeline --label before-v2

# Remote
krishiv -c http://coord.internal:50051 savepoint --job my-pipeline --label before-v2
KRISHIV_COORDINATOR=http://coord.internal:50051 krishiv state inspect --job my-pipeline

All subcommands at a glance

CommandWhat it does
sqlRun a SQL statement. details
explainRun a SQL statement and print logical / physical plan.
stream submit / push / pollRun a continuous window job in-process. details
table readRead a Parquet, Delta, or Hudi file. details
pipeline init / dry-run / runScaffold and execute a pipeline project. details
submitSubmit a job to the in-process R2 scheduler (used by benchmarks and tests).
jobs [--distributed]List running and recent jobs.
state inspectDump per-operator state for a job.
savepointTrigger a named savepoint.
restoreRestart a job from a checkpoint or savepoint.
checkpoints listList valid checkpoint epochs for a job.
local start|stop|restart|statusManage a local Spark-like cluster. details
cluster start|stop|restart|status|verify-networkManage a bare-metal cluster. details
coordinatorRun the active coordinator daemon.
clusterdRun the cluster control plane (co-locates coordinator gRPC + HTTP + optional UI + optional Flight SQL).
job-coordinatorRun a per-job coordinator for very-large-job sharding.
executorRun an executor.
flight-serverRun a standalone Flight SQL server. (Requires flight-sql feature.)
shuffle-svcRun a standalone external shuffle service. (Requires shuffle feature.)

See also