Workers Run

Synopsis

Run a configured worker once in the foreground and wait for it to finish, then exit. Useful for applying a retention policy on demand or for checking that a job does what you expect before trusting it to a schedule.

This opens its own connection to the database. If ‘xodbox serve’ is running against the same file, a job that writes heavily – the purge worker’s VACUUM in particular – can block or fail on SQLite’s write lock. Prefer the admin console’s Run now button, which runs the job inside the live server, or stop the server first.

Interrupt with Ctrl-C to cancel the run’s context; the worker decides how quickly it can stop.

xodbox workers run [name] [flags]

Examples

  xodbox workers run purge

Options

  -h, --help   help for run

Options inherited from parent commands

      --config string   Config file path (default "xodbox.yaml")
      --debug           Debug mode
      --reset-db        Reset database

SEE ALSO

• xodbox workers - Inspect and run background jobs.

Auto generated by spf13/cobra on 1-Sep-2026