mirror of
https://github.com/nukesor/pueue
synced 2024-09-06 16:03:26 +00:00
README
This commit is contained in:
Arne Beer
parent
e74d8d092b
commit
6cd0f387cd
168
README.md
168
README.md
|
|
@ -1,2 +1,166 @@
|
|||
# pueue-rs
|
||||
A fancy daemon for sequential/parallel processing of shell commands whilst easily managing them
|
||||
# Attention!!!
|
||||
|
||||
**This is not stable yet.**
|
||||
You are looking at the Rust rewrite of the program Pueue.
|
||||
The original repository is over [here](https://github.com/nukesor/pueue).
|
||||
Once everything is finished, this master will be pushed to the old repository.
|
||||
|
||||
|
||||
Until then, be aware, that everything is experimental and that the documentation might not be up-to-date.
|
||||
|
||||
|
||||
# Pueue
|
||||
|
||||
[](https://github.com/nukesor/pueue/releases/latest)
|
||||
[](https://travis-ci.org/Nukesor/pueue)
|
||||
[](https://github.com/Nukesor/pueue/blob/master/LICENSE)
|
||||
[](https://pypi.python.org/pypi/pueue)
|
||||
[](https://www.paypal.me/arnebeer/)
|
||||
[](https://www.patreon.com/nukesor)
|
||||
|
||||
|
||||
|
||||
|
||||
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 queue of shell commands with a lot of convenience features and abstractions.
|
||||
|
||||
Since it's not bound to any terminal, you can control your tasks from any terminal on the same machine and even remotely.
|
||||
The best part probably is, that the queue will be continuously processed, even if you no longer have any active ssh session.
|
||||
|
||||
It provides functionality for:
|
||||
- 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)
|
||||
|
||||
|
||||
## Why should I use it?
|
||||
|
||||
I simply guess 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 overchallenged 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 user requested features.
|
||||
|
||||
PRs are of course always welcome!
|
||||
|
||||
## Installation:
|
||||
|
||||
There are three different ways to install Pueue.
|
||||
|
||||
1. Use an Arch Linux AUR package manager e.g. Yay: `yaourt -S pueue` . This will deploy the service file automatically.
|
||||
2. Install by using cargo: `pip install pueue`.
|
||||
3. Clone the repository and execute `python setup.py install`.
|
||||
|
||||
## How to use it:
|
||||
|
||||
There is a help option (-h) for all commands.
|
||||
|
||||
```
|
||||
Pueue client 0.1.0
|
||||
Arne Beer <contact@arne.beer>
|
||||
Interact with the Pueue daemon
|
||||
|
||||
USAGE:
|
||||
pueue [FLAGS] [OPTIONS] [config] <SUBCOMMAND>
|
||||
|
||||
FLAGS:
|
||||
-h, --help Prints help information
|
||||
-V, --version Prints version information
|
||||
-v, --verbose Verbose mode (-v, -vv, -vvv)
|
||||
|
||||
OPTIONS:
|
||||
-a, --address <address> The url for the daemon. Overwrites the address in the config file
|
||||
-p, --port <port> The port for the daemon. Overwrites the port in the config file
|
||||
|
||||
ARGS:
|
||||
<config> Optional custom config path
|
||||
|
||||
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 a 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
|
||||
explicitely `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_address: 127.0.0.1
|
||||
daemon_port: "6924"
|
||||
daemon:
|
||||
pueue_directory: /home/$USER/.local/share/pueue
|
||||
default_parallel_tasks: 1
|
||||
address: 127.0.0.1
|
||||
port: "6924"
|
||||
```
|
||||
|
||||
**Daemon**:
|
||||
- `pueue_directory` The location Pueue uses for it's intermediate files and logs.
|
||||
- `default_parallel_tasks` Determines how many tasks should be processed concurrently.
|
||||
- `address` The address the daemon should listen to.
|
||||
- `port` The port the daemon should listen to.
|
||||
|
||||
**Client**:
|
||||
- `daemon_address` The address the client tries to connect to.
|
||||
- `daemon_port` The port the client tries to connect to.
|
||||
|
||||
|
||||
## 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!
|
||||
|
||||
|
||||
## Utilities
|
||||
|
||||
### Systemd
|
||||
If you use Systemd and don't install Pueue with Yay, place `pueuedaemon.service` in `/etc/systemd/user/`.
|
||||
Afterwards every user can start/enable their own session with:
|
||||
|
||||
systemctl --user start pueuedaemon.service
|
||||
systemctl --user enable pueuedaemon.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](https://github.com/Nukesor))
|
||||
|
|
|
|||
14
utils/pueuedaemon.service
Normal file
14
utils/pueuedaemon.service
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# This is the service file for pueue
|
||||
# To enable the daemon type `systemctl --user enable pueue.service`
|
||||
# To start the daemon type `systemctl --user start pueue.service`
|
||||
|
||||
[Unit]
|
||||
Description=Pueue Daemon
|
||||
|
||||
[Service]
|
||||
Restart=no
|
||||
ExecStart=/usr/bin/pueuedaemon
|
||||
ExecReload=/usr/bin/pueuedaemon
|
||||
|
||||
[Install]
|
||||
WantedBy=default.target
|
||||
Loading…
Reference in a new issue