pueue-status

Show the status of all tasks

$ pueue status

$ pueue status [[-g|--group]] [group_name]

pueue status [OPTIONS]

-g, --group
    Filters the display to show only tasks belonging to the specified group.

-s, --show-stashed
    Includes tasks that are currently stashed (temporarily removed from the active queue) in the output. By default, stashed tasks are not shown.

-j, --json
    Outputs the current state of the Pueue daemon and tasks in machine-readable JSON format, ideal for scripting and automation.

-H, --host
    Specifies the host address where the Pueue daemon is running, if different from the default (localhost).

-p, --port
    Specifies the port number on which the Pueue daemon is listening, if different from the default.

-v, --verbose...
    Increases the verbosity level of the client's output. Can be specified multiple times for more detailed messages.

-q, --quiet...
    Decreases the verbosity level of the client's output. Can be specified multiple times for fewer messages.

-L, --log-level
    Sets the logging level for the client. Possible values include error, warn, info, debug, or trace.

-l, --log-file
    Specifies a file path where the client's log messages should be written.

-c, --config
    Specifies an alternative configuration file for Pueue to use instead of the default location.

-h, --help
    Displays help information for the pueue status command.

pueue status provides a comprehensive overview of the Pueue task queue manager's current state.
It shows tasks that are currently running, paused, queued, or finished, along with their IDs, commands, and statuses.
This command is essential for monitoring and managing ongoing automation workflows or background processes managed by Pueue.
It helps users understand which tasks are active, waiting, or have completed, providing insights into system load and task progression.
It can also display tasks organized by groups and has options for JSON output, which is useful for scripting and integration with other tools.

• The pueue status command requires the Pueue daemon to be actively running in the background to retrieve and display status information.
• By default, only active tasks (queued, running, paused, done, failed) are shown; stashed tasks must be explicitly requested with --show-stashed.
• For large numbers of tasks, the output can be extensive. Utilizing the --group option can help filter and manage the displayed information.

Pueue tasks can exist in various states, which are clearly displayed by pueue status:

• queued: The task is waiting in the queue to be executed.
• running: The task is currently executing.
• paused: The task is in the queue but will not start because the daemon or its group is paused.
• done: The task has completed successfully (exit code 0).
• failed: The task has completed with an error (non-zero exit code).
• stashed: The task has been temporarily moved out of the active queue and will not be processed unless restored.

Pueue allows tasks to be organized into groups, which can be managed (e.g., paused, unpaused, or have parallel execution limits) independently. pueue status can filter its output to show only tasks belonging to a specific group using the --group option, facilitating easier management of complex workflows.

The --json option transforms the output of pueue status into a structured JSON format. This makes the command highly suitable for integration into scripts, automation pipelines, and other monitoring tools that require programmatic access to Pueue's current state.

Pueue is a modern task queue manager designed for simplicity and efficiency in managing local command execution. pueue status has been a core component since its early versions, providing immediate feedback on the daemon's state, which is crucial for its operation and user monitoring. Its functionality has evolved to include filtering by group and JSON output, adapting to growing needs for automation and more complex task management scenarios.

pueue add(1), pueue log(1), pueue pause(1), pueue start(1), pueue reset(1)