pueue-help

Show all available subcommands and flags

$ pueue help

$ pueue help [subcommand]

pueue help [SUBCOMMAND]
pueue --help
pueue [GLOBAL_OPTIONS] SUBCOMMAND --help

SUBCOMMAND
    An optional Pueue subcommand (e.g., add, status) for which to display detailed help information. If omitted, general Pueue usage and a list of all subcommands are shown.

The pueue-help command, commonly invoked as pueue help or pueue --help within the Pueue ecosystem, provides comprehensive assistance for using the Pueue task queue manager. It outlines the main pueue command structure, available global options, and a list of all subcommands with brief descriptions. Users can invoke it to understand how to add, remove, pause, resume, or manage tasks within their Pueue queue. The output serves as a quick reference, detailing the syntax for various operations and guiding users on how to access more specific help for individual subcommands (e.g., pueue help add). It ensures users can efficiently navigate Pueue's features and troubleshoot common usage questions without external documentation.

The pueue-help command itself is not a standard standalone executable; instead, help for Pueue is typically accessed via the `pueue help` subcommand or `pueue --help` flags. The `--daemonless` mode disconnects from the shared queue, making task management operations apply only to an isolated local context.

These options can be applied to the `pueue` command before any subcommand to affect its overall behavior, including when requesting help.

• `-h, --help`: Print help information for the current command or subcommand.
• `-V, --version`: Print Pueue version information.
• `-d, --daemonless`: Run Pueue in daemonless mode. No shared task queue is used.
• `-c CONFIG, --config CONFIG`: Path to a specific Pueue configuration file.
• `-p PROFILE, --profile PROFILE`: The name of the profile that should be loaded from the config.

The `pueue help` command provides information on the following subcommands, which perform various task queue management operations.

• `add`: Add a new command to the queue.
• `clean`: Clean the daemon's log files.
• `config`: Initialize or edit the config file.
• `edit`: Edit a task's command in the queue.
• `enqueue`: (Deprecated) Enqueue a task (use `add` instead).
• `follow`: Follow the output of a specific task in real-time.
• `group`: Add, remove, or switch task groups.
• `log`: Display the full log output of a specific task.
• `pause`: Pause the daemon or specific tasks in the queue.
• `remove`: Remove a task from the queue.
• `restart`: Restart a finished or failed task.
• `resume`: Resume the daemon or specific tasks.
• `status`: Show the current status of the Pueue queue and its tasks.
• `switch`: Switch the position of two tasks in the queue.
• `wait`: Wait for a task to finish execution.

Pueue is a relatively modern task queue runner written in Rust, designed to offer a simpler and more intuitive interface for managing background tasks compared to traditional methods like `nohup`, `screen`, or `tmux` for simple queueing needs. Its development emphasizes user-friendliness, cross-platform compatibility, and robust error handling. The `help` functionality is integral to its design, allowing users to quickly learn and utilize its features directly from the terminal, following a common `git`-like subcommand structure.

pueue(1), nohup(1), at(1), cron(8)