Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darky/bull-repl
Bull / BullMQ queue command line REPL
https://github.com/darky/bull-repl
bull bullmq cli command-line queue repl
Last synced: 4 days ago
JSON representation
Bull / BullMQ queue command line REPL
- Host: GitHub
- URL: https://github.com/darky/bull-repl
- Owner: darky
- License: mit
- Created: 2019-01-26T16:46:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-16T12:56:10.000Z (about 1 month ago)
- Last Synced: 2024-12-20T16:06:41.798Z (11 days ago)
- Topics: bull, bullmq, cli, command-line, queue, repl
- Language: TypeScript
- Homepage:
- Size: 669 KB
- Stars: 230
- Watchers: 4
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bull-repl
Bull / BullMQ queue command line REPL.
### Version compatibility
- For bull 3.x.x use `bull-repl@latest` (0.x.x)
- For bullmq use `bull-repl@next` (1.x.x)
### Install
```
npm install bull-repl -g
```
### Run
```
bull-repl
```
### Overview help
```
help
```
```
Commands:
help [command...] Provides help for a given command.
exit Exits application.
connect [options] Connect to bull queue
connect-list List of saved connections
connect-rm Remove saved connection
connect-save Save current connection
connect-to Connect to saved connection
stats Count of jobs by type
active [options] Fetch active jobs
waiting [options] Fetch waiting jobs
completed [options] Fetch completed jobs
failed [options] Fetch failed jobs
delayed [options] Fetch delayed jobs
pause [options] Pause current queue
resume [options] Resume current queue from pause
get Get job
add [options] Add job to queue e.g. add '{"x": 1}'
rm [options] Remove job
retry [options] Retry job
retry-failed [options] Retry first 100 failed jobs
promote [options] Promote job
fail [options] Move job to failed
complete [options] Move job to completed e.g. complete 1 '{"x": 1}'
clean [options] Clean queue for period ago, period format - https://github.com/zeit/ms#examples
logs [options] Get logs of job
log Add log to job
events-on Turn on logging of queue events
events-off Turn off logging of queue events
```
### Connect help
```
connect --help
```
```
Usage: connect [options]
Connect to bull queue
Options:
--help output usage information
--prefix Prefix to use for all queue jobs
-h, --host Redis host for connection
-p, --port Redis port for connection
-d, --db Redis db for connection
--password Redis password for connection
-c, --cert Absolute path to pem certificate if TLS used
-u, --url Redis sentinel format URL
-e, --exec Exec command
```
### Fetch jobs by group help
```
active --help
```
```
Usage: active [options]
Fetch active jobs
Options:
--help output usage information
-q, --query Query jobs via jq - https://stedolan.github.io/jq/manual/#Basicfilters. Notice, that bull data in root key e.g '[.root[] | select(.progress > 70)]'
-t, --timeAgo Get jobs since time ago via https://github.com/zeit/ms#examples
-s, --start Start index (pagination)
-e, --end End index (pagination)
```
### Notes
- You can see help on each command, for example: `connect --help`
- You can predefine startup command, when run bull-repl. For example: `bull-repl connect my-queue`