Rust CLI
athena_rs command reference for runtime operations, pipelines, and diagnostics.
athena_rs is both the default Athena server binary and the shared CLI
entrypoint. Separate background workers live in the athena-daemon workspace
package, but they still use the same config and environment resolution.
API Runtime Commands
cargo run --
cargo run -- server
cargo run -- --port 4053
cargo run -- --config ./config.yamlcargo run -- --api-only still works, but it is now a deprecated alias for
the default server boot path.
Separate Worker Binaries
cargo run -p athena-daemon --bin athena_daemon
cargo run -p athena-daemon --bin athena_clone_worker
cargo run -p athena-daemon --bin athena_backup_worker
cargo run -p athena-daemon --bin athena_deferred_query_worker
cargo run -p athena-daemon --bin athena_typesense_worker
cargo run -p athena-daemon --bin athena_daemon_legacy_workersAll of these binaries resolve the same ATHENA_CONFIG_PATH and load the same
.env beside the resolved config file.
- For a full split runtime, set
daemon.enabled: trueand runathena_daemon, or run one dedicated binary per daemon-owned worker family. - For a clone-only hybrid runtime,
daemon.enabledcan stayfalsebecause clone execution is never started byathena_rs.
Pipeline and Gateway Commands
cargo run -- pipeline --client <NAME> --pipeline <NAME> --payload-json '{...}'
cargo run -- fetch --client <NAME> --body-json '{...}'Client Registry Commands
cargo run -- clients list
cargo run -- clients add <NAME> <POSTGRES_URI>
cargo run -- clients remove <NAME>
cargo run -- clients set-default <NAME>Use --path <PATH> with these subcommands when the client registry is not at
config/clients.json.
Operational Commands
cargo run -- provision --uri <POSTGRES_URI> --register --client-name <NAME>
cargo run -- pools --url http://localhost:4052 --admin-key <KEY>
cargo run -- pressure-worker
cargo run -- install --dry-run
cargo run -- diag
cargo run -- versioninstall is the Linux host-provisioning helper. diag prints a JSON runtime
snapshot. pools queries live SQLx pool telemetry from a running Athena
instance.
CDC Commands
cargo run -- cdc backfill --url <URL> --csv-path src/cdc/sequin_events.csv
cargo run -- cdc stream --url <URL> --sequin-table public.sequin_eventsThese commands are available when Athena is built with the cdc feature. The
workspace default feature set enables it.
Global Overrides
--config/--config-path--pipelines--port--max-workers--api-only(deprecated alias for default server boot)--cdc-onlywhen thecdcfeature is enabled
ATHENA_CONFIG_PATH can also be used for config resolution.