A rich terminal UI for Sidekiq.
- View Sidekiq processes and currently running jobs
- Explore Sidekiq queues and jobs
- Inspect job arguments and error backtraces
- View Sidekiq retries, scheduled, and dead jobs
- Analyze errors in dead and retry queues
- Check job execution metrics
- ... more to come!
Tip
Latest installation instructions for different platforms are available on the Lazykiq website.
Note
Lazykiq uses Unicode box-drawing and chart glyphs in the UI; a modern UTF-8 terminal font is recommended.
You can download the latest release from the Releases page for your platform.
Alternatively, install the current development version with go install:
go install github.com/kpumuk/lazykiq/cmd/lazykiq@latest1-8- switch viewsj/k- navigate down / up (orDown/Up)h/l- navigate left / right (orLeft/Right)Enter- view job details,Escto close[/]- previous / next page{/}- switch interval on the dashboard or metrics/- filter job list (case-sensitive)q- quit
Connect to a specific Redis instance with:
lazykiq --redis redis://localhost:6379/0We use mise for development. Install tooling with:
mise installRun all CI tasks with:
mise run ciBuild the app locally with:
mise run buildBuild a smaller release binary with:
mise run build-releaseReleases are published from signed v* tags through the GitHub Actions release workflow.
- Only release tags matching
v*should be used to trigger a release. - Release artifacts are built by GoReleaser, include SBOMs, and ship with signed checksums plus GitHub artifact attestations.
- The maintainer is responsible for creating release tags and for reviewing release-environment secrets and publishing configuration before a release.
To update all dependencies:
mise run depsLefthook can be used to setup Git hooks:
lefthook installThis will ensure we do not push any dependencies with known vulnerabilities, and the code quality matches our standards.
There is a test environment prepared in the demo/ directory. Simply start it with:
mise run demo
mise run demo-sidekiq73
mise run demo-sidekiq80
mise run demo-sidekiq81This will:
- Start a Redis server
- Start one Sidekiq demo stack for the selected version, with demo jobs and the Web interface
| Command | Sidekiq | Redis URL | Web Dashboard |
|---|---|---|---|
mise run demo |
8.1.0 | redis://localhost:6379/0 |
http://localhost:9292 |
mise run demo-sidekiq73 |
7.3.x | redis://localhost:6379/2 |
http://localhost:9294 |
mise run demo-sidekiq80 |
8.0.0 | redis://localhost:6379/1 |
http://localhost:9293 |
mise run demo-sidekiq81 |
8.1.0 | redis://localhost:6379/0 |
http://localhost:9292 |
The version-specific tasks can run in parallel because each demo stand uses its own Redis database and dashboard port.
You can connect to a specific Sidekiq version using:
go run ./cmd/lazykiq --redis redis://localhost:6379/1The documentation website is built with Hugo. To run it locally:
mise run website-devI’d love to hear your thoughts on this project. Feel free to drop a note!
MIT.