Reference
Canonical, source-cited reference for Resonate defaults, the resonate CLI, and schedule/cron behavior.
The reference section is the single source of truth for the facts that don't change with the page you're reading — default values across the server and SDKs, the surface of the resonate CLI, and how schedules and cron expressions behave.
Every page cites every value back to a specific file and line in the canonical source repositories. If a default or a flag changes in source, the page is wrong until it is updated.
What's here#
Defaults reference#
Every default value, in one place, cited file:line:
- Server defaults — every flag of
resonate serve/resonate dev, sourced fromresonatehq/resonatesrc/config.rs - SDK init defaults — TypeScript, Python, Rust constructor defaults (
url,group,pid,ttl,logLevel, workers) ctx.run/ per-call options — defaulttimeout,target,version,tags, retry policy resolution- Retry policies —
Exponential,Constant,Linear,Never— defaults per SDK - Cross-SDK parity table — where TS, Python, and Rust agree and where they don't (timeouts, ttls, retry-policy time units)
- Environment variables — every
RESONATE_*variable the SDKs read
Use it when you need to know "what does X default to?" and want a citation, not a paraphrase.
CLI reference#
Every resonate subcommand, with scenarios and worked examples:
resonate dev/resonate serve— start the server (in-memory vs persistent)resonate invoke— trigger a registered function from the shellresonate promises— direct CRUD + search on durable promisesresonate tasks— task lifecycle for custom workers and operator recoveryresonate schedules— cron-driven recurring jobsresonate tree— call-graph visualisation rooted at a promise ID (debugging)resonate mcp— start the MCP server (stdio) so Claude Code or any MCP client can drive Resonate directly- Common scenarios — start a dev server and invoke a function, inspect a stuck workflow, cancel in flight, register a recurring job, wire into Claude Code
Use it when you need to know "what command do I run for X?" and want a working example.
Schedules & cron reference#
How schedules behave on the server, independent of SDK or CLI:
- Cron expression format — 5/6/7-field layouts, with examples
- Day-of-week convention — Quartz numbering (
1= Sunday), why day names likeMON-FRIare the safe form - Timezone — expressions evaluate in UTC only; there is no timezone option
- The
resonate:targetrequirement — the routing tag every schedule must carry, and the exact error when it's missing - Promise-ID templates — the two substituted variables (
{{.id}},{{.timestamp}}) and why templates need{{.timestamp}} - Tags on fired promises — what the server injects at fire time, and how to search fired promises
Use it when a schedule fires at the wrong time, fires and nothing runs, or won't create.
How to use the reference pages#
The pages are sister surfaces:
- Defaults answers "what is the default for X?" — read it when you need a value.
- CLI answers "how do I run X?" — read it when you need a command.
- Schedules & cron answers "why did my schedule do that?" — read it when cron behavior surprises you.
If a CLI flag's default surprises you, the CLI page links to the matching row on the defaults page. If a default value's owner isn't obvious, the defaults page links to the command that exposes it.
For agents#
Both pages are designed to be Echo-indexed and MCP-friendly:
- Every value and command is cited file:line, so a follow-up "show me the source" question resolves cleanly
- Scenarios are written as runnable commands, so an agent that finishes reading can hand the user a working example
- Cross-references between sibling pages are explicit, so a question about "the default
--tasks-retry-timeout" routes correctly even if it lands on the wrong page first
If you're building an agent against a Resonate server, the resonate mcp subcommand is the entry point: it exposes the most-used promise operations as MCP tools that wrap the same surface this section documents.