https://github.com/juhaku/watchmux
Multiplexed watch in Rust
https://github.com/juhaku/watchmux
command-line multiplex rust watch
Last synced: about 2 months ago
JSON representation
Multiplexed watch in Rust
- Host: GitHub
- URL: https://github.com/juhaku/watchmux
- Owner: juhaku
- License: apache-2.0
- Created: 2022-07-28T21:43:54.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-13T20:48:29.000Z (over 1 year ago)
- Last Synced: 2025-02-26T07:35:21.662Z (2 months ago)
- Topics: command-line, multiplex, rust, watch
- Language: Rust
- Homepage:
- Size: 44.9 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# watchmux ~ Mux all your watch processes in Rust
Watchmux is a simple async cli tool to mux all your watch processes to single stdout.
Watchmux can run any number of commands or custom shell scripts which will be
executed with bash when type is set to `shell`. Shell scripts and commands can
be named with title and they can be provided with additional set of environment
variables. Commands and shell scripts are executed in parallel and each output
will be multiplexed to single stdout. Currently hard limit for concurrent
processes is 1024. Program will exit when all processes complete or by pressing
`` to terminate program.
https://github.com/juhaku/watchmux/assets/26358664/99df340c-b5c6-4b6e-8561-9c5e6a654d4a
## Install
Install it directly from git with following command.
```bash
cargo install --git https://github.com/juhaku/watchmux
```
## Usage
```bash
USAGE:
watchmux [OPTIONS]
OPTIONS:
-c, --config
Path to the config file of watchmux
-h, --help
Print help information
```
## Configuration file syntax (.watchmuxrc.yaml)
```yaml
processes:
- title: command title
cmd: echo hello world $NAME
type: shell
env:
NAME: Nate
- title: cargo
cmd: cargo run
wait_for: while [[ $status -ne 200 ]]; do $status=0; sleep 1; done
```
* **title**: text shown left most of the output to distinct where the output is originated.
* **cmd**: the actual command or shell script to exeucte e.g `cargo run` or with type `shell`
this can multiline shell script e.g.
```bash
cmd: |
while [[ true == true ]]; do
echo "this is true"
sleep 1
done
```
* **type**: `shell` or `cmd` which is default if not provided. `shell` for shell script which
are exeucted with bash -c `cmd`. `cmd` is executed as is and is expected to be found from `$PATH`
* **env**: map of environment variables to provided to `cmd`.
* **wait_for**: additonal command that need to complete before the `cmd` will be executed.
## Examples
Run wathcmux with `.watchmuxrc.yaml` in current directory:
```bash
watchmux
```
Run watchmux with custom config file:
```bash
watchmux -c path/to/config
```
Run watchmux with config from stdin:
```bash
cat <