Skip to main content

CLI command flags

This page lists all available flags and their usage across commands.

Global flags​

These are flags that can be used with any command.

--config​

Server config file (default "resonate.yml")

--log-level​

Log level, can be one of:

  • debug
  • info (default)
  • warn
  • error

--password​

Basic auth password

--server​

Server address used by the client (default "http://127.0.0.1:8001").

--username​

Basic auth username

Command flags​

These are flags that are specific to a command.

--cron​

Schedule cron expression.

Used in:

--description​

Schedule description.

Used in:

--idempotency-key​

An optional idempotency key to ensure idempotency in promise operations.

Used in:

--strict​

Enforces strict mode in promise operations. Default is true.

Used in:

--template​

Specifies the name of the template to be used to create the project.

Used in:

--timeout​

Specifies the timeout duration for promises

Used in:

--promise-timeout​

Specifies the timeout duration for promises in Schedules.

Used in:

--data​

Specifies the data for promises.

Used in:

--header​

Specifies headers for promise requests.

Used in:

--name​

Specifies the name of your project.

Used in:

--tag​

Assigns tags to promises or schedules.

Used in:

--promise-tag​

Promise tags. Default is [].

Used in:

--promise-data​

Promise param data

Used in:

--promise-header​

Promise param header. Default is [].

Used in:

--promise-id​

Templated schedule id, can include {{.timestamp}}.

Used in:

--state​

Filters promises by state.

Used in:

--limit​

Limits the number of results in searches.

Used in:

--cursor​

Pagination cursor for search results.

Used in:

--output​

Specifies the output format.

Used in:

--api-size​

Specifies the size of the submission queue buffered channel for the API.

Used in:

--api-http-addr​

Sets the HTTP server address for the API. Default is "0.0.0.0:8001".

Used in:

--api-http-timeout​

Specifies the graceful shutdown timeout for the HTTP server. Default is 10s.

Used in:

--api-grpc-addr​

Sets the gRPC server address for the API. Default is "0.0.0.0:50051".

Used in:

--api-base-url​

Sets the base URL used to generate absolute URLs for the server's resources. Default is "http://localhost:8001".

Used in:

--api-http-auth​

Provides basic authentication with username/password pairs for HTTP requests. Default is [].

Used in:

--aio-size​

Specifies the size of the completion queue buffered channel for AIO. Default is 100.

Used in:

--aio-store​

Specifies the type of promise store (e.g., sqlite, postgres). Default is "sqlite".

Used in:

--aio-store-size​

Specifies the size of the store submission queue buffered channel for AIO. Default is 100.

Used in:

--aio-store-workers​

Specifies the number of concurrent store connections for AIO. Default is 1

Used in:

--aio-store-batch-size​

Specifies the maximum number of submissions processed by a store worker per tick. Default is 100.

Used in:

--aio-store-sqlite-path​

Specifies the SQLite database path. Default is "resonate.db".

Used in:

--aio-store-sqlite-tx-timeout​

Specifies the SQLite transaction timeout. Default is 10s.

Used in:

--aio-store-sqlite-reset​

Enables resetting the SQLite database on shutdown.

Used in:

--aio-store-postgres-host​

Specifies the PostgreSQL host. Default is "localhost".

Used in:

--aio-store-postgres-port​

Specifies the PostgreSQL port. Default is "5432".

Used in:

--aio-store-postgres-username​

Specifies the PostgreSQL username.

Used in:

--aio-store-postgres-password​

Specifies the PostgreSQL password.

Used in:

--aio-store-postgres-database​

Specifies the PostgreSQL database name. Default is "resonate".

Used in:

--aio-store-postgres-query​

Specifies query options for PostgreSQL. Default is [].

Used in:

--aio-store-postgres-tx-timeout​

Specifies the PostgreSQL transaction timeout. Default is 10s.

Used in:

--aio-store-postgres-reset​

Enables resetting the PostgreSQL database on shutdown.

Used in:

--aio-network-size​

Specifies the size of the network submission queue buffered channel for AIO. Default is 100.

Used in:

--aio-network-workers​

Specifies the number of concurrent HTTP requests for the network. Default is 3.

Used in:

--aio-network-batch-size​

Specifies the maximum number of submissions processed by a network worker per tick. Default is 100.

Used in:

--aio-network-timeout​

Specifies the network request timeout. Default is 10s.

Used in:

--aio-queuing-size​

Specifies the size of the queuing submission queue buffered channel for AIO. Default is 100.

Used in:

--aio-queuing-batch-size​

Specifies the maximum number of submissions processed by a queuing worker per tick. Default is 100.

Used in:

--aio-queuing-connections​

Specifies the queuing subsystem connections.

Used in:

--aio-queuing-routes​

Specifies the queuing subsystem routes.

Used in:

--system-coroutine-max-size​

Specifies the maximum number of coroutines to run concurrently. Default is 1000.

Used in:

--system-notification-cache-size​

Specifies the maximum number of notifications to keep in the cache. Default is 100.

Used in:

--system-submission-batch-size​

Specifies the maximum number of submissions to process on each tick. Default is 100.

Used in:

--system-completion-batch-size​

Specifies the maximum number of completions to process on each tick. Default is 100.

Used in:

--system-schedule-batch-size​

Specifies the maximum number of schedules to process on each tick. Default is 1000.

Used in:

--metrics-port​

Specifies the Prometheus metrics server port. Default is 9090.

Used in:

--ignore-asserts​

Enables ignore-asserts mode.

Used in:

--counter​

The counter is a feature that keeps track of the number of Tasks. It increments each time a new Task is added and decrements when a Task is completed or removed.

Used in:

--process-id​

Unique process ID that identifies the claimant.

Used in:

--ttl​

Time to live.

Used in: