Skip to content

Latest commit

 

History

History
92 lines (73 loc) · 2.57 KB

README.md

File metadata and controls

92 lines (73 loc) · 2.57 KB
Raw

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 <C-c> to terminate program.

watchmux-demo.mp4

Install

Install it directly from git with following command.

cargo install --git https://github.com/juhaku/watchmux

Usage

USAGE:
    watchmux [OPTIONS]

OPTIONS:
    -c, --config <FILE>
            Path to the config file of watchmux

    -h, --help
            Print help information

Configuration file syntax (.watchmuxrc.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. 
    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:

watchmux

Run watchmux with custom config file:

watchmux -c path/to/config

Run watchmux with config from stdin:

cat <<EOF | watchmux -c -
processes:
  - title: foobar
    cmd: echo foobar
    type: shell
EOF

License

Licensed under either of Apache 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be dual licensed, without any additional terms or conditions.