Skip to content

wayfarer

The command-line interface to Wayfarer.

Usage

wayfarer [OPTIONS] [perform|enqueue|execute|route|tree]

See Configuration for the respected environment variables.

wayfarer perform JOB URL

Performs JOB with URL in memory. The task is not sent to the message queue. Staged jobs are ignored.

Options
  • --mock-redis: Use an in-memory implementation of Redis instead of talking to an actual server.
  • --batch=BATCH: The job's batch. By default, a UUID is generated.

wayfarer enqueue JOB URL

Enqueues a task for JOB with URL to the message queue.

Options
  • --batch=BATCH: The job's batch. By default, a UUID is generated.

wayfarer execute JOB URL

Execute JOB with URL with the in-memory Active Job Async adapter instead of writing the taks to an actual message queue. Blocks until the batch has completed.

Options
  • --mock-redis: Use an in-memory implementation of Redis instead of talking to an actual server.
  • --batch=BATCH: Set the job's batch. By default, a UUID is generated.
  • --min-threads: Minimum number of threads to use. Default: 1
  • --max-threads: Maximum number of threads to use. Default: 1

Why are my jobs not getting retried with wayfarer job execute?

You need to set the wait: 0 option on retry_on in order for wayfarer job execute to execute retries:

retry_on StandardError, attempts: 3, wait: 0

wayfarer route JOB URL

Prints the result of invoking JOB's router with URL.

wayfarer tree JOB URL

Visualises the routing tree result of invoking JOB's router with URL.