tforgione
/
multiview
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
tforgione 2023-11-06 11:36:34 +01:00
parent dc950ad0d4
commit b9c31c2251
1 changed files with 64 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
README.md
View File

@ -1,59 +1,64 @@
# multiview-rs
*Run many commands and watch all outputs in a single terminal*
## Installation
If rust is not already installed, [install rust](https://www.rust-lang.org/tools/install).
Then run:
```sh
cargo install --git https://gitea.tforgione.fr/tforgione/multiview
```
## Usage
Split your terminal in two rows, the first containing three columns, and the second containing one column:
```sh
multiview cmd1 :: cmd2 :: cmd3 // cmd4 :: cmd5
```
Split your terminal in two columns, the first containing three rows, and the second containing one row:
```sh
multiview cmd1 // cmd2 // cmd3 :: cmd4 // cmd5
```
## Colors
Most well written programs will disable colors when running from multiview, in order to force them to use colors, you
can use the `unbuffer` command from the [`expect` package](https://packages.ubuntu.com/search?keywords=expect).
```sh
multiview unbuffer cmd1 :: unbuffer cmd2
```
## Shortcuts
- `k`: kills the current tile
- `K`: kills all tiles
- `r`: restarts the current tile
- `R`: restarts all tiles
- `l`: draw a line on the current tile
- `L`: draw a line on all tiles
- `q`: quits
## Limitations
*Don't resize your terminal... just don't* :cry:
## History
This is my attempt to rewrite [arjunmehta's multiview](https://github.com/arjunmehta/multiview) in rust.
Their version has many features that I don't use, but is missing a few things that I need:
- line wrapping: when a line is bigger than the terminal size, the end is just not displayed
- scroll: if your output has more lines than your terminal height, there is no way (to my knowledge) to scroll up
# multiview-rs
*Run many commands and watch all outputs in a single terminal*
![multiview preview](/screenshots/row-major.png)
## Installation
If rust is not already installed, [install rust](https://www.rust-lang.org/tools/install).
Then run:
```sh
cargo install --git https://gitea.tforgione.fr/tforgione/multiview
```
## Usage
Split your terminal in two rows, the first containing three columns, and the second containing one column:
```sh
multiview cmd1 :: cmd2 :: cmd3 // cmd4 :: cmd5
```
![multiview row major preview](/screenshots/row-major.png)
Split your terminal in two columns, the first containing three rows, and the second containing one row:
```sh
multiview cmd1 // cmd2 // cmd3 :: cmd4 // cmd5
```
![multiview col major preview](/screenshots/col-major.png)
## Colors
Most well written programs will disable colors when running from multiview, in order to force them to use colors, you
can use the `unbuffer` command from the [`expect` package](https://packages.ubuntu.com/search?keywords=expect).
```sh
multiview unbuffer cmd1 :: unbuffer cmd2
```
## Shortcuts
- `k`: kills the current tile
- `K`: kills all tiles
- `r`: restarts the current tile
- `R`: restarts all tiles
- `l`: draw a line on the current tile
- `L`: draw a line on all tiles
- `q`: quits
## Limitations
*Don't resize your terminal... just don't* :cry:
## History
This is my attempt to rewrite [arjunmehta's multiview](https://github.com/arjunmehta/multiview) in rust.
Their version has many features that I don't use, but is missing a few things that I need:
- line wrapping: when a line is bigger than the terminal size, the end is just not displayed
- scroll: if your output has more lines than your terminal height, there is no way (to my knowledge) to scroll up