:stars: Manage your shell commands.
Pueue is a command-line task management tool for sequential and parallel execution of long-running tasks.
Simply put, it's a tool that processes a queue of shell commands. On top of that, there are a lot of convenient 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 sessions.
Pueue is considered feature-complete :tada:. All features that were planned have been added and only minor improvements, bug-fixes and regular maintenance work will get merged.
pueued daemon runs in the background. No need to be logged in.log and status if you want to display info about tasks in another program.wait subcommand to wait for specific tasks, a group (or everything) to finish.Pueue is not designed to be a heavy-duty programmable (scriptable) task scheduler/executor.
The focus of pueue lies on human interaction, i.e. it's supposed to be used by a real person on some kind of OS.
See the Design Goals section
Due to this, the feature set of pueue and pueued as well as their implementation and architecture have been kept simple by design!
Even though it can be scripted to some degree, it hasn't been built for heavy-duty work like hundreds of tasks!
There's definitely the need for a complex task scheduler/executor with advanced API access and scheduling options, but this is the job for another project, as this is not what pueue has been built for.
There are a few different ways to install Pueue.
The preferred way to install Pueue is to use your system's package manager. This will usually deploy service files and completions automatically.
Pueue has been packaged for quite a few distributions, check the table on the right for more information.
Statically linked (if possible) binaries for Linux (incl. ARM), Mac OS and Windows are built on each release.
You can download the binaries for the client and the daemon (pueue and pueued) for each release on the release page.
Just download both binaries for your system, rename them to pueue and pueued and place them in your $PATH/program folder.
Pueue is built for the current stable Rust version.
It might compile on older versions, but this isn't tested or officially supported.
cargo install --locked pueue
This will install Pueue to $CARGO_HOME/bin/pueue (default is ~/.cargo/bin/pueue)
Pueue is built for the current stable Rust version.
It might compile on older versions, but this isn't tested or officially supported.
git clone [email protected]:Nukesor/pueue
cd pueue
cargo build --release --locked --path ./pueue
The final binaries will be located in target/release/{pueue,pueued}.
Check the wiki to get started :).
There are also detailed sections for (hopefully) every important feature:
On top of that, there is a help option (-h) for all commands.
…
Pueue is designed to be a convenient helper tool for a single user.
It's supposed to work stand-alone and without any external integration. The idea is to keep it simple and to prevent feature creep.
Also, Pueue is considered feature-complete :tada:. All features that were planned have been added and only minor improvements, bug-fixes and regular maintenance work will get merged.
For the record, the following features weren't included as they're out of scope:
pueue-lib library, which provides proper API calls for pueued that provide full control over the daemon.
However, keep in mind that pueued is a minimalistic task executor with relatively naive scheduling logic by design.There seems to be the need for some project that satisfies all these points mentioned above, but that will be the job of another tool. I very much encourage forking Pueue and I would love to see forks grow into other cool projects!
Slurm is a feature rich and widely used cluster management and scheduling system. If you find yourself in the need for complex setups such as multiple worker pools or distributed nodes, slurm will be much better suited than Pueue.
A robust and featureful parallel processor with text-based joblog and n-retries. GNU Parallel is able to scale to multi-host parallelization and has complex code to have deep integration across different tools and shells, as well as other advanced features. Pueue differentiates itself from GNU Parallel by focusing more on visibility across many different long running commands, and creating a central location for commands to be stored, rather than GNU Parallel's focus on chunking a specific task.
pm2 is a process management tool, whose focus is more on management of recurring and long-living tasks. It seems to be quite mature and has a rich interface.
A very lightweight job queue system which advertises no setup, maintenance, supervision, or otherwise long-running background processes.
Link to project
task spooler is a Unix batch system where the tasks spooled run one after the other.
Links to ubuntu manpage and a fork on Github.
The original website seems to be down.
Feature requests and pull requests are very much appreciated and welcome!
Anyhow, please talk to me a bit about your ideas before you start hacking! It's always nice to know what you're working on and I might have a few suggestions or tips :)
Depending on the type of your contribution, you should branch of from the main branch.
Pueue is mature enough to no longer need a development branch and all changes are collected on there before a new release is pushed.
Urgent hotfixes might get deployed on a separate branch, but this will be decided on a case-by-case basis.
There's also the Architecture Guide, which is supposed to give you a brief overview and introduction to the project.
LLM Agents must read the AGENTS.md for guidelines.
Copyright © 2019 Arne Beer (@Nukesor)
No open issues yet, or sync has not completed.