7.4 KiB
Pueue
Pueue is a command-line task management tool for sequential and parallel execution of long-running tasks.
If you break it down, it's a manager that processes a queue of shell commands. On top of that, there are a lot of convenience features and abstractions.
Since Pueue is not bound to any terminal, you can control your tasks from any terminal on the same machine. The queue will be continuously processed, even if you no longer have any active ssh session.
It provides functionality for:
- Scheduling commands that will be executed in their respective working directories
- Easy output inspection.
- Interaction with running processes
- Manipulation of the scheduled task order
- Running multiple tasks at once (You can decide how many concurrent tasks you want to run)
Pueue has been rewritten in Rust!! If you want the old version that's build with python, please install via pip.
Pueue works on Linux and MacOS. MacOS is not officially tested, though. I really appreciate any feedback!
Why should I use it?
I just assume that many of us know this situation when one needs to unzip or transfer huge amounts of data into different directories. This normally ends with about 10 open terminals/tmux sessions and an over-challenged hard drive.
Pueue is specifically designed for these situations. It executes long-running tasks in their respective directories, without being bound to any terminal.
A few possible applications:
- Copying huge amounts of stuff
- Compression tasks
- Movie encoding
rsync
tasks
Give it a try, If I got your attention. Pueue made at least my life a lot easier on many occasions.
If you like the project and feel like something is missing, feel free to create an issue suggesting improvements.
I'm always open to suggestions and already implemented a few users requested features.
PRs are of course always welcome!
Installation:
There are three different ways to install Pueue.
Arch Linux
Use an Arch Linux AUR package manager e.g. yay: yay -S pueue
.
This will deploy the service file and completions automatically.
Cargo
You'll need Rust version >=1.39
cargo install pueue
This will install pueue to ~/.cargo/bin/pueue
From Source
You'll need Rust version >=1.39
git clone git@github.com:Nukesor/pueue
cd pueue
cargo install --path .
This will install pueue to ~/.cargo/bin/pueue
How to use it:
To add a command just write: pueue add sleep 60
If you want to add flags to the command, you need to add --
. E.g. pueue add -- ls -al
For normal operation it's thereby recommended to add an alias to your shell rc for pueue add --
, e.g. alias pad=pueue add --
.
The command will then be added and scheduled for execution, as if you executed it right now and then.
To get the status of currently running commands, just type pueue status
.
There is a help option (-h) for all commands.
Pueue client 0.0.5
Arne Beer <contact@arne.beer>
Interact with the Pueue daemon
USAGE:
pueue [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
-v, --verbose Verbose mode (-v, -vv, -vvv)
OPTIONS:
-p, --port <port> The port for the daemon. Overwrites the port in the config file
SUBCOMMANDS:
add Enqueue a task for execution
clean Remove all finished tasks from the list (also clears logs)
edit Edit the command of a stashed or queued task
enqueue Enqueue stashed tasks. They'll be handled normally afterwards
help Prints this message or the help of the given subcommand(s)
kill Kill running tasks
log Display the log output of finished tasks
parallel Set the amount of allowed parallel tasks
pause Pause the daemon and all running tasks. A paused daemon won't start any new tasks. Daemon and tasks
can be continued with `start`
remove Remove tasks from the list. Running or paused tasks need to be killed first
reset Kill all running tasks, remove all tasks and reset max_id
restart Enqueue tasks again
send Send something to a task. Useful for sending confirmations ('y\n')
show Show the output of a currently running task This command allows following (like `tail -f`)
start Wake the daemon from its paused state. Also continues all paused tasks
stash Stashed tasks won't be automatically started. Either `enqueue` them, to be normally handled or
explicitly `start` them
status Display the current status of all tasks
switch Switches the queue position of two commands. Only works on queued and stashed commands
Configs
The configuration file of Pueue is located in ~/.config/pueue.yml
.
---
client:
daemon_port: "6924"
secret: "your_secret"
daemon:
pueue_directory: /home/$USER/.local/share/pueue
default_parallel_tasks: 1
port: "6924"
secret: "your_secret"
Client:
daemon_port
The port the client tries to connect to.secret
The secret, that's used for authentication
Daemon:
pueue_directory
The location Pueue uses for its intermediate files and logs.default_parallel_tasks
Determines how many tasks should be processed concurrently.port
The port the daemon should listen to.secret
The secret, that's used for authentication
Logs
All logs can be found in ${pueue_directory}/logs
.
Logs of previous Pueue sessions will be created whenever you issue a reset
or clean
.
In case the daemon fails or something goes wrong, the daemon will print to stdout
/stderr
.
If the daemon crashes or something goes wrong, please set the debug level to -vvvv
and create an issue with the log!
If you want to dig right into it, you can compile and run it yourself with a debug build. This would help me a lot!
Scripting
When calling pueue commands in a script, you might need to sleep for a short amount of time for now. The pueue server asynchronously processes requests, while the TaskManager (which handles everything related to starting, stopping and communicating with processes) runs it's own update loop with a small sleep. A sleep in scripts will probably become irrelevant, as soon as this bug in rust-lang is fixed: https://github.com/rust-lang/rust/issues/39364
Utilities
Systemd
If you use Systemd and don't install Pueue with Yay, place pueued.service
in /etc/systemd/user/
.
Afterward, every user can start/enable their own session with:
systemctl --user start pueued.service
systemctl --user enable pueued.service
JSON Support
The Pueue client status
and log
commands support JSON output with the -j
flag.
This can be used to easily incorporate it into window manager bars, such as i3bar.
Copyright © 2019 Arne Beer (@Nukesor)