Minion:...on::job(3)

πŸ’– Minion::Command::minion::job β€” the job command, bestie πŸ’–

okay so this is a page from the User Contributed Perl Documentation collection, and it's literally all about Minion::Command::minion::job, which is your girl for managing the Minion job queue. no cap. πŸŽ€


✨ NAME ✨

Minion::Command::minion::job β€” the Minion job command. that's it, that's the name. πŸ’…


🌈 SYNOPSIS 🌈

here's the vibe, copy-paste ready:

Usage: APPLICATION minion job [OPTIONS] [IDS]

  ./myapp.pl minion job
  ./myapp.pl minion job 10023
  ./myapp.pl minion job -w
  ./myapp.pl minion job -w 23
  ./myapp.pl minion job -s
  ./myapp.pl minion job -f 10023
  ./myapp.pl minion job -q important -t foo -t bar -S inactive
  ./myapp.pl minion job -q 'host:localhost' -S inactive
  ./myapp.pl minion job -e foo -a '[23, "bar"]'
  ./myapp.pl minion job -e foo -x 1 -P 10023 -P 10024 -p 5 -q important
  ./myapp.pl minion job -e 'foo' -n '{"test":123}'
  ./myapp.pl minion job -R -d 10 -E 300 10023
  ./myapp.pl minion job --remove 10023
  ./myapp.pl minion job --retry-failed
  ./myapp.pl minion job -n '["test"]'
  ./myapp.pl minion job -L
  ./myapp.pl minion job -L some_lock some_other_lock
  ./myapp.pl minion job -b jobs -a '[12]'
  ./myapp.pl minion job -b jobs -a '[12]' 23 24 25

and then, the whole menu of options πŸ“

Options:
  -A, --attempts <number>     Number of times performing this new job will be
                              attempted, defaults to 1
  -a, --args <JSON array>     Arguments for new job or worker remote control
                              command in JSON format
  -b, --broadcast <command>   Broadcast remote control command to one or more
                              workers
  -d, --delay <seconds>       Delay new job for this many seconds
  -E, --expire <seconds>      New job is valid for this many seconds before
                              it expires
  -e, --enqueue <task>        New job to be enqueued
  -f, --foreground            Retry job in "minion_foreground" queue and
                              perform it right away in the foreground (very
                              useful for debugging)
  -H, --history               Show queue history
  -h, --help                  Show this summary of available options
      --home <path>           Path to home directory of your application,
                              defaults to the value of MOJO_HOME or
                              auto-detection
  -L, --locks                 List active named locks
  -l, --limit <number>        Number of jobs/workers to show when listing
                              them, defaults to 100
  -m, --mode <name>           Operating mode for your application, defaults to
                              the value of MOJO_MODE/PLACK_ENV or
                              "development"
  -n, --notes <JSON>          Notes in JSON format for new job or list only
                              jobs with one of these notes
  -o, --offset <number>       Number of jobs/workers to skip when listing
                              them, defaults to 0
  -P, --parent <id>           One or more jobs the new job depends on
  -p, --priority <number>     Priority of new job, defaults to 0
  -q, --queue <name>          Queue to put new job in, defaults to "default",
                              or list only jobs in these queues
  -R, --retry                 Retry job
      --retry-failed          Retry all failed jobs at once
      --remove                Remove job
      --remove-failed         Remove all failed jobs at once
  -S, --state <name>          List only jobs in these states
  -s, --stats                 Show queue statistics
  -T, --tasks                 List available tasks
  -t, --task <name>           List only jobs for these tasks
  -U, --unlock <name>         Release named lock
  -w, --workers               List workers instead of jobs, or show
                              information for a specific worker
  -x, --lax <bool>            Jobs this job depends on may also have failed
                              to allow for it to be processed

πŸ‘‘ OPTIONS πŸ‘‘

one bullet each, bestie, no skips:

  • -A, --attempts <number> β€” how many times this new job gets attempted. defaults to 1.
  • -a, --args <JSON array> β€” args for a new job, or for a worker remote control command, and they gotta be in JSON format. 🌸
  • -b, --broadcast <command> β€” broadcast a remote control command out to one or more workers. group chat, but for workers. πŸ“£
  • -d, --delay <seconds> β€” delay the new job by this many seconds. it can wait, she's busy. ⏳
  • -E, --expire <seconds> β€” the new job stays valid for this many seconds before it expires. periodt.
  • -e, --enqueue <task> β€” the new job you wanna enqueue. πŸ’Œ
  • -f, --foreground β€” retry the job in the "minion_foreground" queue and perform it right away, in the foreground. very useful for debugging, fr fr. πŸ”
  • -H, --history β€” show the queue history. the receipts. 🧾
  • -h, --help β€” show this summary of available options. classic.
  • --home <path> β€” path to the home directory of your application. defaults to the value of MOJO_HOME or auto-detection. 🏠
  • -L, --locks β€” list active named locks. πŸ”’
  • -l, --limit <number> β€” how many jobs/workers to show when listing them. defaults to 100.
  • -m, --mode <name> β€” operating mode for your application. defaults to the value of MOJO_MODE/PLACK_ENV or "development". ✨
  • -n, --notes <JSON> β€” notes in JSON format for a new job, or list only the jobs with one of these notes. πŸ“
  • -o, --offset <number> β€” how many jobs/workers to skip when listing them. defaults to 0.
  • -P, --parent <id> β€” one or more jobs that the new job depends on. it's giving family tree. 🌳
  • -p, --priority <number> β€” priority of the new job. defaults to 0.
  • -q, --queue <name> β€” the queue to put the new job in, defaults to "default", or list only jobs in these queues. πŸ’œ
  • -R, --retry β€” retry the job. πŸ”
  • --retry-failed β€” retry all failed jobs at once. all of them. every last one. 😭
  • --remove β€” remove the job. bye bestie πŸ‘‹
  • --remove-failed β€” remove all failed jobs at once. spring cleaning energy. 🧹
  • -S, --state <name> β€” list only jobs in these states.
  • -s, --stats β€” show queue statistics. numbers, slay. πŸ“Š
  • -T, --tasks β€” list available tasks.
  • -t, --task <name> β€” list only jobs for these tasks.
  • -U, --unlock <name> β€” release a named lock. πŸ”“
  • -w, --workers β€” list workers instead of jobs, or show info for a specific worker. πŸ‘·
  • -x, --lax <bool> β€” jobs that this job depends on may also have failed, and it'll still allow this job to be processed. lenient queen. 🫢

🌸 DESCRIPTION 🌸

Minion::Command::minion::job manages the Minion job queue. that's the whole job description (pun fully intended) and honestly? iconic. πŸ‘‘


πŸ¦‹ ATTRIBUTES πŸ¦‹

Minion::Command::minion::job inherits all attributes from Mojolicious::Command and implements the following new ones. inheritance? we love to see it.

πŸ’– description

my $description = $job->description;
$job            = $job->description('Foo');

short description of this command, used for the command list. it's the lil one-liner in the lineup. ✨

πŸ’– usage

my $usage = $job->usage;
$job      = $job->usage('Foo');

usage information for this command, used for the help screen. the how-to, basically.


🧚 METHODS 🧚

Minion::Command::minion::job inherits all methods from Mojolicious::Command and implements the following new ones.

πŸ’– run

$job->run(@ARGV);

run this command. that's it. go off. πŸš€


πŸŽ€ SEE ALSO πŸŽ€

go read these too, bestie, they're all connected:


and that's the whole page, no notes left behind, every flag accounted for πŸ’…

signing off: this was perl v5.42.0, dated 2026-01-17, brought to you by Minion:...on::job(3). mwah. πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from