Forrest logo
tool overview
On this page you find all important commands for the CLI tool pueue. If the command you are looking for is missing please ask our AI.

pueue

Pueue is a command line tool for managing long-running tasks in UNIX environments. It stands for "Parallel Command Execution Queue."

It provides a simple and efficient way to manage the execution and scheduling of commands. You can enqueue one or multiple commands, which will be executed in order, making it easier to manage complex workflows.

One of Pueue's main features is the ability to parallelize tasks. It allows you to run multiple commands simultaneously, making sure that the system resources are utilized efficiently.

Pueue provides an interactive and user-friendly interface in the terminal. It displays a queue of tasks, their status, and any output generated by the commands. You can pause, resume, or abort tasks as needed, making it easy to control the execution according to your requirements.

It also supports advanced features like task dependencies and prioritization. You can set up tasks that depend on the successful completion of other tasks, ensuring that they are executed in the correct order. Additionally, you can assign priority levels to tasks to control their execution order.

Pueue supports multiple queues, allowing you to group tasks and manage them separately. This can be helpful when you have different sets of tasks or different priorities within a workflow.

The tool supports notifications, so you can receive alerts when tasks complete or encounter errors. This feature ensures that you can stay updated on the progress of your tasks even when you are not actively monitoring the tool.

Pueue is highly customizable, with various configuration options available. You can adjust settings like the number of parallel tasks, log verbosity, and notification preferences according to your needs.

It integrates well with other command-line tools and shells, making it easy to incorporate into your existing workflows. You can use it in conjunction with other tools like cron for task scheduling or integrate it into shell scripts.

Pueue is an open-source project, licensed under the MIT License, making it freely accessible and modifiable by the community. It is actively maintained and has a growing user base, ensuring ongoing development and support.

List of commands for pueue:

  • pueue-add:tldr:4db91 pueue-add: Add any command to the default queue.
    $ pueue add ${command}
    try on your machine
    explain this command
  • pueue-clean:tldr:81105 pueue-clean: Only clean commands that finished successfully.
    $ pueue clean --successful-only
    try on your machine
    explain this command
  • pueue-clean:tldr:8ceec pueue-clean: Remove finished tasks and clear logs.
    $ pueue clean
    try on your machine
    explain this command
  • pueue-completions:tldr:8fc3c pueue-completions: Generate completions for Bash.
    $ sudo pueue completions bash ${-usr-share-bash-completion-completions-pueue-bash}
    try on your machine
    explain this command
  • pueue-completions:tldr:cb36d pueue-completions: Generate completions for zsh.
    $ sudo pueue completions zsh ${-usr-share-zsh-site-functions}
    try on your machine
    explain this command
  • pueue-completions:tldr:d89a7 pueue-completions: Generate completions for fish.
    $ sudo pueue completions fish ${-usr-share-fish-completions}
    try on your machine
    explain this command
  • pueue-edit:tldr:780ed pueue-edit: Edit a task, see `pueue status` to get the task ID.
    $ pueue edit ${task_id}
    try on your machine
    explain this command
  • pueue-edit:tldr:ea7e5 pueue-edit: Edit the path from which a task is executed.
    $ pueue edit ${task_id} --path
    try on your machine
    explain this command
  • pueue-enqueue:tldr:1949d pueue-enqueue: Enqueue a stashed task after four months.
    $ pueue enqueue --delay "4 months" ${task_id}
    try on your machine
    explain this command
  • pueue-enqueue:tldr:1a602 pueue-enqueue: Enqueue a stashed task after 60 seconds.
    $ pueue enqueue --delay ${60} ${task_id}
    try on your machine
    explain this command
  • pueue-enqueue:tldr:60e00 pueue-enqueue: Enqueue multiple stashed tasks at once.
    $ pueue enqueue ${task_id} ${task_id}
    try on your machine
    explain this command
  • pueue-enqueue:tldr:d2ef3 pueue-enqueue: List all available date/time formats.
    $ pueue enqueue --help
    try on your machine
    explain this command
  • pueue-follow:tldr:8aa91 pueue-follow: Follow the output of a task (`stdout` + `stderr`).
    $ pueue follow ${task_id}
    try on your machine
    explain this command
  • pueue-follow:tldr:d4348 pueue-follow: Follow the `stderr` of a task.
    $ pueue follow --err ${task_id}
    try on your machine
    explain this command
  • pueue-group:tldr:5fe19 pueue-group: Remove a group and move its tasks to the default group.
    $ pueue group --remove "${group_name}"
    try on your machine
    explain this command
  • pueue-group:tldr:70e3b pueue-group: Add a custom group.
    $ pueue group --add "${group_name}"
    try on your machine
    explain this command
  • pueue-group:tldr:7a782 pueue-group: Show all groups with their statuses and number of parallel jobs.
    $ pueue group
    try on your machine
    explain this command
  • pueue-help:tldr:186f7 pueue-help: Show help for a specific subcommand.
    $ pueue help ${subcommand}
    try on your machine
    explain this command
  • pueue-help:tldr:e4e72 pueue-help: Show all available subcommands and flags.
    $ pueue help
    try on your machine
    explain this command
  • pueue-kill:tldr:178a9 pueue-kill: Kill all tasks in the default group.
    $ pueue kill
    try on your machine
    explain this command
  • pueue-kill:tldr:1a456 pueue-kill: Kill a task and terminate all its child processes.
    $ pueue kill --children ${task_id}
    try on your machine
    explain this command
  • pueue-kill:tldr:45453 pueue-kill: Kill all tasks across all groups and pause all groups.
    $ pueue kill --all
    try on your machine
    explain this command
  • pueue-kill:tldr:60ba8 pueue-kill: Kill a specific task.
    $ pueue kill ${task_id}
    try on your machine
    explain this command
  • pueue-kill:tldr:d7def pueue-kill: Kill all tasks in a group and pause the group.
    $ pueue kill --group ${group_name}
    try on your machine
    explain this command
  • pueue-log:tldr:03602 pueue-log: Show the full output of a task.
    $ pueue log ${task_id}
    try on your machine
    explain this command
  • pueue-log:tldr:a91a4 pueue-log: Show the last few lines of output from all tasks.
    $ pueue log
    try on your machine
    explain this command
  • pueue-log:tldr:b1924 pueue-log: Print a specific number of lines from the tail of output.
    $ pueue log --lines ${number_of_lines} ${task_id}
    try on your machine
    explain this command
  • pueue-log:tldr:c2a76 pueue-log: Show the last few lines of output from several tasks.
    $ pueue log ${task_id} ${task_id}
    try on your machine
    explain this command
  • pueue-parallel:tldr:23608 pueue-parallel: Set the maximum number of tasks allowed to run in parallel, in a specific group.
    $ pueue parallel --group ${group_name} ${maximum_number_of_parallel_tasks}
    try on your machine
    explain this command
  • pueue-parallel:tldr:bf0ae pueue-parallel: Set the maximum number of tasks allowed to run in parallel, in the default group.
    $ pueue parallel ${max_number_of_parallel_tasks}
    try on your machine
    explain this command
  • pueue-pause:tldr:4733d pueue-pause: Pause all tasks and prevent all groups from starting new tasks.
    $ pueue pause --all
    try on your machine
    explain this command
  • pueue-pause:tldr:94b6b pueue-pause: Pause a running task.
    $ pueue pause ${task_id}
    try on your machine
    explain this command
  • pueue-pause:tldr:99749 pueue-pause: Pause all tasks in a group and prevent it from starting new tasks.
    $ pueue pause --group ${group_name}
    try on your machine
    explain this command
  • pueue-pause:tldr:d2578 pueue-pause: Pause a running task and stop all its direct children.
    $ pueue pause --children ${task_id}
    try on your machine
    explain this command
  • pueue-pause:tldr:f1b34 pueue-pause: Pause all tasks in the default group.
    $ pueue pause
    try on your machine
    explain this command
  • pueue-remove:tldr:1ae7e pueue-remove: Remove a killed or finished task.
    $ pueue remove ${task_id}
    try on your machine
    explain this command
  • pueue-remove:tldr:51e89 pueue-remove: Remove multiple tasks at once.
    $ pueue remove ${task_id} ${task_id}
    try on your machine
    explain this command
  • pueue-reset:tldr:7b262 pueue-reset: Reset without asking for confirmation.
    $ pueue reset --force
    try on your machine
    explain this command
  • pueue-reset:tldr:88d81 pueue-reset: Kill all tasks, terminate their children, and reset everything.
    $ pueue reset --children
    try on your machine
    explain this command
  • pueue-reset:tldr:c2981 pueue-reset: Kill all tasks and remove everything (logs, status, groups, task IDs).
    $ pueue reset
    try on your machine
    explain this command
  • pueue-restart:tldr:42b6d pueue-restart: Restart a specific task from a different path.
    $ pueue restart --edit-path ${task_id}
    try on your machine
    explain this command
  • pueue-restart:tldr:511f0 pueue-restart: Restart a task in-place (without enqueuing as a separate task).
    $ pueue restart --in-place ${task_id}
    try on your machine
    explain this command
  • pueue-restart:tldr:63132 pueue-restart: Restart all failed tasks and stash them.
    $ pueue restart --all-failed --stashed
    try on your machine
    explain this command
  • pueue-restart:tldr:742fe pueue-restart: Restart multiple tasks at once, and start them immediately (do not enqueue).
    $ pueue restart --start-immediately ${task_id} ${task_id}
    try on your machine
    explain this command
  • pueue-restart:tldr:cfe7b pueue-restart: Restart a specific task.
    $ pueue restart ${task_id}
    try on your machine
    explain this command
  • pueue-restart:tldr:d2082 pueue-restart: Edit a command before restarting.
    $ pueue restart --edit ${task_id}
    try on your machine
    explain this command
  • pueue-send:tldr:06c2c pueue-send: Send input to a running command.
    $ pueue send ${task_id} "${input}"
    try on your machine
    explain this command
  • pueue-shutdown:tldr:d8eec pueue-shutdown: Shutdown the daemon without a service manager.
    $ pueue shutdown
    try on your machine
    explain this command
  • pueue-start:tldr:5d6d6 pueue-start: Resume multiple tasks at once.
    $ pueue start ${task_id} ${task_id}
    try on your machine
    explain this command
  • pueue-start:tldr:8ff9e pueue-start: Resume all tasks in a specific group.
    $ pueue start group ${group_name}
    try on your machine
    explain this command
  • pueue-start:tldr:a01d9 pueue-start: Resume a specific task.
    $ pueue start ${task_id}
    try on your machine
    explain this command
  • pueue-start:tldr:d0f13 pueue-start: Resume all tasks in the default group.
    $ pueue start
    try on your machine
    explain this command
  • pueue-start:tldr:f1fa6 pueue-start: Resume all tasks and start their children.
    $ pueue start --all --children
    try on your machine
    explain this command
  • pueue-stash:tldr:23426 pueue-stash: Enqueue a task to be executed when preceding tasks finish.
    $ pueue enqueue ${task_id}
    try on your machine
    explain this command
  • pueue-stash:tldr:5254d pueue-stash: Stash multiple tasks at once.
    $ pueue stash ${task_id} ${task_id}
    try on your machine
    explain this command
  • pueue-stash:tldr:62ef0 pueue-stash: Stash an enqueued task.
    $ pueue stash ${task_id}
    try on your machine
    explain this command
  • pueue-status:tldr:cb5b3 pueue-status: Show the status of a specific group.
    $ pueue status --group ${group_name}
    try on your machine
    explain this command
  • pueue-status:tldr:cb8da pueue-status: Show the status of all tasks.
    $ pueue status
    try on your machine
    explain this command
  • pueue-switch:tldr:c09bc pueue-switch: Switch the priority of two tasks.
    $ pueue switch ${task_id1} ${task_id2}
    try on your machine
    explain this command
  • pueue:tldr:0336c pueue: Check the version of pueue.
    $ pueue --version
    try on your machine
    explain this command
  • pueue:tldr:57dd8 pueue: Execute a pueue subcommand.
    $ pueue ${subcommand}
    try on your machine
    explain this command
  • pueue:tldr:d78d9 pueue: Show general help and available subcommands.
    $ pueue --help
    try on your machine
    explain this command
tool overview