Using the pueue command (with examples)

1: Show general help and available subcommands

pueue --help

Motivation:

When first getting started with the pueue command, it can be helpful to have a quick overview of the available subcommands and their usage.

Explanation:

By running pueue --help, you can display the general help information for the pueue command. This will provide a list of all available subcommands, along with a brief description of each subcommand’s purpose. Additionally, this command will show you how to get more detailed information on specific subcommands by running pueue <subcommand> --help.

Example Output:

pueue 0.9.1
Nukesor
A task management tool for sequential and parallel execution of long-running tasks.
Some subcommands such as `pueue add` have their own usage documentation.
More information: <https://github.com/Nukesor/pueue>

USAGE:
    pueue [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -v, --version    Prints version information
    -V, --verbose    Prints verbose output

OPTIONS:
    -C, --config <CONFIG>    Sets a custom config file

SUBCOMMANDS:
    add        Add new tasks to the queue
    clean      Clean the pueue log. Remove entries from the log file when their corresponding output files don't exist anymore
    completion  Generate shell completion scripts
    edit       Edit a task's command or environment variables
    help       Prints this message or the help of the given subcommand(s)
    logs       Display the output of finished tasks
    move       Move tasks around within the queue
    pause      Pause the execution of tasks
    remove     Remove tasks from the queue
    reset      Reset the whole pueue. Kill everything and remove the history
    restart    Restart finished or failed tasks
    start      Start the pueue daemon
    status     Show the current state of pueue
    stop       Stop the pueue daemon
    wait       Wait until the specified task id is finished. This is useful when waiting for a special task to
            finish, before adding dependent tasks
    which      Get the path of the pueue binary

Use 'pueue help <command>' for more information on a specific command.

2: Check the version of pueue

pueue --version

Motivation:

Checking the version of pueue can be useful when troubleshooting or trying to determine if you have the most recent version installed.

Explanation:

By running pueue --version, you can quickly check the version of pueue that is installed on your system. This can be helpful for verifying that you are using the correct version, especially if you have recently updated the software.

Example Output:

pueue 0.9.1

3: Execute a pueue subcommand

pueue subcommand

Motivation:

To use the power of pueue, you need to execute specific subcommands that will allow you to manage your tasks effectively.

Explanation:

To execute a specific pueue subcommand, you can simply run pueue <subcommand>. Replace <subcommand> with the desired subcommand to perform actions such as adding tasks, starting the pueue daemon, checking the status, etc.

Example Output:

The output will depend on the specific subcommand executed. For example, if you run pueue status to check the current state of pueue, you would see the following output:

┌────────────┬────────────────┬───┐
│ Queue name │ Label      Task │   │
│ ────────── │ ─────────────── │ ─ │
│ 0           │ Task 0         │   │
│ 1           │ Task 1         │   │
└────────────┴────────────────┴───┘

This output shows the queue name, along with the label and task of each item in the queue.