didil/sidekiq-client-cli

Command line client for Sidekiq

sidekiq-client-cli

A command line client for Sidekiq You can use this when you need to interact with Sidekiq via the command line, for example in cron jobs.

Installation

Add this line to your application's Gemfile:

gem 'sidekiq-client-cli'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sidekiq-client-cli

Dependencies

Requires sidekiq >= 2.15.0

Usage

Push worker classes to Sidekiq :

$ sidekiq-client push MyWorker OtherWorker

You can specify a sidekiq config file via the -c option (if not specified the usual rails path config/initializers/sidekiq.rb is used) :

$ sidekiq-client -c mysidekiq.conf push MyWorker OtherWorker

You can also specify a specific queue to push the jobs to :

$ sidekiq-client -q my_queue push MyWorker OtherWorker

You can specify that the job should not be retried, if it fails :

$ sidekiq-client -r false push MyWorker OtherWorker

You can also specify the number of times a job should be retried, if it fails :

$ sidekiq-client -r 5 push MyWorker OtherWorker

For help :

$ sidekiq-client --help

Contributing to sidekiq-client-cli

• Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
• Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
• Fork the project.
• Start a feature/bugfix branch.
• Commit and push until you are happy with your contribution.
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

sidekiq-client-cli's Issues

Sidekiq Job not processing .

When i am executing job through console, it processed without any problem. When i am running through sidekiq-client-cli, it show in enqueued tab when view sidekiq web but it never getting processed

Passing arguments using ZSH

Hey,

As far as I understood, I can pass arguments to the worker like this:

sidekiq-client push MyWorker args[1,2] 

The problem with that is because I'm getting zsh: no matches found: args[1,2] . I'm using Oh-my-Zsh. Am I doing something wrong?

Incompatible with sidekiq 2.17.1?

In my Gemfile:
gem 'sidekiq-client-cli', github: 'didil/sidekiq-client-cli', require: false

% bundle
...
Resolving dependencies...
Bundler could not find compatible versions for gem "sidekiq":
In Gemfile:
sidekiq-client-cli (>= 0) ruby depends on
sidekiq (~> 2.15.0) ruby

sidekiq (2.17.1)

Error with sidekiq 2.15.0

bundle/ruby/2.0.0/gems/sidekiq-client-cli-0.1.2/lib/sidekiq_client_cli.rb:8:in
`<class:SidekiqClientCLI>': uninitialized constant
Sidekiq::Worker::ClassMethods::DEFAULT_OPTIONS (NameError)

OtherWorker == command-args ?

The example that is given is this:

sidekiq-client push MyWorker OtherWorker

How does the command line know that OtherWorker isn't command-args*?

Please update for Sidekiq 3

Bundler could not find compatible versions for gem "sidekiq":
  In Gemfile:
    sidekiq-client-cli (>= 0) ruby depends on
      sidekiq (~> 2.15) ruby

    sidekiq (3.0.0)

How to make sidekiq-client-cli working with environments?

Hi there,

I use Sidekiq and Sidekiq in different environments (development/staging/production)

First at all, I try to configure my redis-server into my rails-app/config/environments/[development.rb | staging.rb | production.rb]

It took me a while to understand that sidekiq-client-cli does NOT read those files.

So I try to configure it into my rails-app/config/initilizers/sidekiq.rb

my code looks like this :

if Rails.env.production?
  Sidekiq.configure_server do |config|
    config.redis = {:url => 'redis://sidekiq.hidutyfree.com:7372/12'}
  end

  Sidekiq.configure_client do |config|
    config.redis = {:url => 'redis://sidekiq.hidutyfree.com:7372/12'}
  end
end

But in fact, when I call bundle exec sidekiq-client it raise an error and say

uninitialized constant Rails
config/initializers/sidekiq.rb:4:in `<top (required)>'

How to make it work?

uninitialized constant SidekiqClientCLI::CLI

Using version 0.1.7, sidekiq 3.4.2

bundle exec sidekiq-client push ScheduleCurrentPostsWorker
uninitialized constant SidekiqClientCLI::CLI /home/vagrant/.rbenv/versions/2.2.2/lib/ruby/gems/2.2.0/gems/sidekiq-client-cli-0.1.7/lib/sidekiq_client_cli.rb:12:inparse'
/home/vagrant/.rbenv/versions/2.2.2/lib/ruby/gems/2.2.0/gems/sidekiq-client-cli-0.1.7/bin/sidekiq-client:7:in <top (required)>' /home/vagrant/.rbenv/versions/2.2.2/bin/sidekiq-client:23:inload'
/home/vagrant/.rbenv/versions/2.2.2/bin/sidekiq-client:23:in <main>'