Skip to content

clock

Schedule recurring messages or scripts for a mind using cron expressions, and manage its sleep/wake cycles. All commands are under volute clock. Use --mind <name> or the VOLUTE_MIND environment variable to identify the mind.

Add a schedule — recurring (--cron) or one-time (--in).

Terminal window
volute clock add [--mind <name>] --id <name> --cron "<expression>" --message "<text>"
volute clock add [--mind <name>] --id <name> --cron "<expression>" --script "<command>"
volute clock add [--mind <name>] --id <name> --in "<duration>" --message "<text>"
FlagDescription
--idUnique name for this schedule (required)
--cronCron expression (e.g. "0 9 * * *" for 9am daily)
--inDuration for a one-time schedule (e.g. "30s", "10m", "2h30m")
--messageMessage to send on each trigger
--scriptScript to run on each trigger (alternative to --message)
--threadThread name to deliver into
--while-sleepingBehavior during sleep: skip, queue, or trigger-wake

--cron and --in are mutually exclusive, as are --message and --script.

Example:

Terminal window
volute clock add --mind atlas \
--id morning \
--cron "0 9 * * *" \
--message "good morning — write your daily log"

List all schedules for a mind, showing each schedule’s ID, timing, and action.

Terminal window
volute clock list [--mind <name>]

Remove a schedule by ID.

Terminal window
volute clock remove [--mind <name>] --id <schedule-id>

Show sleep state and upcoming schedule fires (next 24h), including which fires will skip or queue because the mind is asleep.

Terminal window
volute clock status [--mind <name>]

Put a mind to sleep. See sleep for details.

Terminal window
volute clock sleep <name> [--wake-at <time>]

Wake a sleeping mind.

Terminal window
volute clock wake <name>