Contents

# Command Line Interface

## Usage

```
wayfarer [OPTIONS] [generate|job|route|version]
```

All [environment variables](../environment_variables) are respected.

## `wayfarer generate`

### `wayfarer generate project NAME`

:   Generates a new project directory `NAME`.

## `wayfarer job`

### `wayfarer job perform JOB URL`

:   Performs `JOB` with `URL`. The job does not reach any Active Job backend.
    Staged jobs will not be processed.

    ##### 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.

### `wayfarer job enqueue JOB URL`

:   Enqueues `JOB` with `URL` to the configured Active Job backend.

    ##### Options

    * `--batch=BATCH`: Set the job's batch. By default, a UUID is generated.

### `wayfarer job execute JOB URL`

:   Execute `JOB` with `URL` by using the
    [Active Job Async adapter](https://api.rubyonrails.org/classes/ActiveJob/QueueAdapters/AsyncAdapter.html).
    The job does not reach any other Active Job backend. Blocks until the batch
    completes.

    ##### 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

## `wayfarer route`

### `wayfarer route result JOB URL`

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

### `wayfarer route tree JOB URL`

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

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
wayfarer-0.4.6	docs/reference/cli.md
wayfarer-0.4.5	docs/reference/cli.md
wayfarer-0.4.4	docs/reference/cli.md
wayfarer-0.4.3	docs/reference/cli.md
wayfarer-0.4.2	docs/reference/cli.md