arnavon

Opinionated producer/consumer framework on top of RabbitMQ.

• Usage
• Commands

Usage

$ npm install -g @quadrabee/arnavon
$ arnavon COMMAND
running command...
$ arnavon (--version)
@quadrabee/arnavon/1.3.1 darwin-x64 node-v22.18.0
$ arnavon --help [COMMAND]
USAGE
  $ arnavon COMMAND
...

Commands

• arnavon help [COMMANDS]
• arnavon queues
• arnavon queues:base
• arnavon queues:requeue QUEUENAME
• arnavon queues:status
• arnavon start
• arnavon start:api
• arnavon start:consumer [NAME]

arnavon help [COMMANDS]

Display help for arnavon.

USAGE
  $ arnavon help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for arnavon.

See code: @oclif/plugin-help

arnavon queues

Queue management commands

USAGE
  $ arnavon queues

arnavon queues:base

USAGE
  $ arnavon queues:base

arnavon queues:requeue QUEUENAME

Requeue messages from a dead letter queue back to the original queue

USAGE
  $ arnavon queues:requeue QUEUENAME [-c <value>] [-n <value>]

ARGUMENTS
  QUEUENAME  The name of the dead letter queue to requeue from

FLAGS
  -c, --config=<value>  [default: config.yaml] location of config file (defaults to 'config.yaml').
  -n, --count=<value>   Number of messages to requeue (default: all messages)

DESCRIPTION
  Requeue messages from a dead letter queue back to the original queue

  Moves messages from a dead letter queue back to the original queue for reprocessing.

  This command uses the RabbitMQ Shovel plugin to efficiently move messages.
  Messages are republished to the exchange with their original routing key.

  Examples:
  $ arnavon queue requeue my-queue
  $ arnavon queue requeue my-queue --count 10
  $ arnavon queue requeue my-queue -n 100 -c config.yaml

arnavon queues:status

Show the status of queues (messages, consumers)

USAGE
  $ arnavon queues:status [-c <value>]

FLAGS
  -c, --config=<value>  [default: config.yaml] location of config file (defaults to 'config.yaml').

DESCRIPTION
  Show the status of queues (messages, consumers)

  Displays the status of all configured queues, including the number of messages and consumers.

  This command connects to RabbitMQ and retrieves information about all queues defined in the topology.

  Examples:
  $ arnavon queues:status
  $ arnavon queues:status -c config.yaml

arnavon start

Starts an arnavon component

USAGE
  $ arnavon start

arnavon start:api

The REST API provides ways to push Jobs to queues, with validation

USAGE
  $ arnavon start:api [-c <value>] [-p <value>]

FLAGS
  -c, --config=<value>  [default: config.yaml] location of config file (defaults to 'config.yaml').
  -p, --port=<value>    Port to use for API (default 3000)

arnavon start:consumer [NAME]

Starts an Arnavon consumer

USAGE
  $ arnavon start:consumer [NAME] [-c <value>] [-x <value> -a] [-p <value>]

ARGUMENTS
  NAME  The name of the consumer to start

FLAGS
  -a, --all                Start all consumers instead of just one (not recommended, but can be useful in dev)
  -c, --config=<value>     [default: config.yaml] location of config file (defaults to 'config.yaml').
  -p, --port=<value>       Port to use for API (default 3000)
  -x, --except=<value>...  Specify a consumer that should not be started. (Requires -a/--all. Can be used multiple
                           times)