https://github.com/andyblarblar/cliplot
A command line application for live-plotting data
https://github.com/andyblarblar/cliplot
cli cross-platform plotting rust
Last synced: over 1 year ago
JSON representation
A command line application for live-plotting data
- Host: GitHub
- URL: https://github.com/andyblarblar/cliplot
- Owner: andyblarblar
- License: mit
- Created: 2022-11-22T05:09:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-26T05:14:09.000Z (over 3 years ago)
- Last Synced: 2025-02-28T12:00:01.519Z (over 1 year ago)
- Topics: cli, cross-platform, plotting, rust
- Language: Rust
- Homepage:
- Size: 26.6 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cliplot
A command line application for live-plotting data.
Features:
- Live plotting from stdin
- 1-many input channels
- Configurable regex for each channel
- Log data to CSV while plotting
- Cross-platform
## Usage
```
cliplot will live plot data piped into stdin. It can plot multiple channels, parse data with regex, save data to a CSV, and more.
Usage: cliplot [OPTIONS]
Options:
-r, --regexes
Regex strings to parse each channel with. If this is not specified, then a single channel that parses for `$float$` will be used.
Each regex should be unambiguous from the others, and contain one capture group that contains a string convertable to a f64. Deliminators (such as the `$` above) are necessary to avoid numbers being cut across buffer breaks.
--csv
Writes read data into a CSV file at path if set.
The CSV file will contain the timestamp of each reading in ms, followed by the data and finally the channel number.
-v, --verbose...
More output per occurrence
-q, --quiet...
Less output per occurrence
-h, --help
Print help information (use `-h` for a summary)
-V, --version
Print version information
```
- cliplot uses [Rust regex syntax](https://docs.rs/regex/latest/regex/#syntax). Be careful with shell interpretations of symbols like $.
- Some shells like bash have issues with multiple regex strings. In this case, just use multiple `-r` flags in order.
- To double-check your regex is being interpreted correctly, run with -vvv. To see the data being parsed, run with -vvvv.
## Examples
```shell
some stream | cliplot
```
Plots data from an input stream, parsing for `\$([+|-]?\d*\.?\d*)\$` (a float surrounded by $)
---
```shell
python3 print_with_delta.py 0.0032 | cliplot -r '\$([+|-]?\d*\.?\d*)\$' -r '%([+|-]?\d*\.?\d*)%' --csv test.csv
```
Plots data from a [python script](test_assets/print_with_delta.py), with channel 0 deliminated by $$ and channel 1 deliminated
by %%. Also log this data to a CSV file called test.csv.
## Installation
### From source
```shell
cargo install cliplot
```
or with this repo
```shell
cargo build --release
# Binary is in target/release
target/release/cliplot --help
```
### Binaries
The GitHub releases tab should have debian archives and portable Windows builds.