https://github.com/YS-L/csvlens
Command line csv viewer
https://github.com/YS-L/csvlens
Last synced: 20 days ago
JSON representation
Command line csv viewer
- Host: GitHub
- URL: https://github.com/YS-L/csvlens
- Owner: YS-L
- License: mit
- Created: 2021-08-14T16:59:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T05:37:46.000Z (6 months ago)
- Last Synced: 2024-10-29T15:10:52.613Z (6 months ago)
- Language: Rust
- Homepage:
- Size: 2.67 MB
- Stars: 2,586
- Watchers: 11
- Forks: 43
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-tools - csvlens
- my-awesome-github-stars - YS-L/csvlens - Command line csv viewer (Rust)
- awesome-ratatui - csvlens - Command line csv viewer. (💻 Apps / 🚀 Productivity and Utilities)
README
# csvlens
`csvlens` is a command line CSV file viewer. It is like `less` but made
for CSV.
## Usage
Run `csvlens` by providing the CSV filename:
```
csvlens
```
Pipe CSV data directly to `csvlens`:
```
| csvlens
```
### Key bindings
Key | Action
--- | ---
`hjkl` (or `← ↓ ↑→ `) | Scroll one row or column in the given direction
`Ctrl + f` (or `Page Down`) | Scroll one window down
`Ctrl + b` (or `Page Up`) | Scroll one window up
`Ctrl + d` (or `d`) | Scroll half a window down
`Ctrl + u` (or `u`) | Scroll half a window up
`Ctrl + h` | Scroll one window left
`Ctrl + l` | Scroll one window right
`Ctrl + ←` | Scroll left to first column
`Ctrl + →` | Scroll right to last column
`G` (or `End`) | Go to bottom
`g` (or `Home`) | Go to top
`G` | Go to line `n`
`/` | Find content matching regex and highlight matches
`n` (in Find mode) | Jump to next result
`N` (in Find mode) | Jump to previous result
`&` | Filter rows using regex (show only matches)
`*` | Filter columns using regex (show only matches)
`TAB` | Toggle between row, column or cell selection modes
`>` | Increase selected column's width
`<` | Decrease selected column's width
`Shift + ↓` (or `Shift + j`) | Sort rows or toggle sort direction by the selected column
`#` (in Cell mode) | Find and highlight rows like the selected cell
`@` (in Cell mode) | Filter rows like the selected cell
`y` | Copy the selected row or cell to clipboard
`Enter` (in Cell mode) | Print the selected cell to stdout and exit
`-S` | Toggle line wrapping
`-W` | Toggle line wrapping by words
`f` | Freeze this number of columns from the left
`r` | Reset to default view (clear all filters and custom column widths)
`H` (or `?`) | Display help
`q` | Exit
### Optional parameters
* `-d `: Use this delimiter when parsing the CSV
(e.g. `csvlens file.csv -d '\t'`).
Specify `-d auto` to auto-detect the delimiter.
* `-t`, `--tab-separated`: Use tab as the delimiter (when specified, `-d` is ignored).
* `-i`, `--ignore-case`: Ignore case when searching. This flag is ignored if any
uppercase letters are present in the search string.
* `--no-headers`: Do not interpret the first row as headers.
* `--columns `: Use this regex to select columns to display by default.
* `--filter `: Use this regex to filter rows to display by default.
* `--find `: Use this regex to find and highlight matches by default.
* `--echo-column `: Print the value of this column at the selected
row to stdout on `Enter` key and then exit.
## Installation
### Direct download
You can download the `tar.xz` or `zip` file matching your operating system from the
[releases page](https://github.com/YS-L/csvlens/releases), extract it and execute the `csvlens`
binary.
### Homebrew
For macOS, `csvlens` is available on [Homebrew](https://formulae.brew.sh/formula/csvlens). You can
install it using:
```
brew install csvlens
```
### Arch Linux
`csvlens` is available in the [official repositories](https://archlinux.org/packages/extra/x86_64/csvlens). You can install it using:
```
pacman -S csvlens
```
### Windows
For Windows, `csvlens` is available on [winget](https://learn.microsoft.com/en-gb/windows/package-manager/). You can install it using:
```powershell
winget install --id YS-L.csvlens
```
### FreeBSD
`csvlens` is available as a [FreeBSD pkg](https://www.freshports.org/textproc/csvlens/). You can install it using:
```
pkg install csvlens
```
### NetBSD
`csvlens` is available on [pkgsrc](https://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/textproc/csvlens/index.html). If you're using NetBSD you can install it using:
```
pkgin install csvlens
```
### OpenBSD
`csvlens` is available as an [OpenBSD port](https://cvsweb.openbsd.org/ports/textproc/csvlens/). If you're using OpenBSD 7.6-current or later, you can install it using:
```
doas pkg_add csvlens
```
### Cargo
If you have [Rust](https://www.rust-lang.org/tools/install) installed, `csvlens` is available on
[crates.io](https://crates.io/crates/csvlens) and you can install it using:
```
cargo install csvlens
```
Or, build and install from source after cloning this repo:
```
cargo install --path $(pwd)
```
## Library Usage
This crate allows you to use csvlens as a library.
In your `Cargo.toml`, add the following:
```toml
[dependencies]
csvlens = { version = "0.12.0", default-features = false, features = ["clipboard"] }
```
### Example
Here's a simple example of how to use `csvlens` as a library ([Documentation](https://docs.rs/csvlens/0.12.0/csvlens/index.html)):
```rust
use csvlens::run_csvlens;
let out = run_csvlens(&["/path/to/your.csv"]).unwrap();
if let Some(selected_cell) = out {
println!("Selected: {}", selected_cell);
}
```
For more advanced usage, you can use `CsvlensOptions` to customize the behavior:
```rust
use csvlens::{run_csvlens_with_options, CsvlensOptions};
let options = CsvlensOptions {
filename: "/path/to/your.csv".to_string(),
delimiter: Some("|".to_string()),
ignore_case: true,
debug: true,
..Default::default()
};
let out = run_csvlens_with_options(options).unwrap();
if let Some(selected_cell) = out {
println!("Selected: {}", selected_cell);
}
```
See how [qsv](https://github.com/dathere/qsv/tree/master?tab=readme-ov-file#qsv-blazing-fast-data-wrangling-toolkit) uses `csvlens` as a library [here](https://github.com/dathere/qsv/blob/master/src/cmd/lens.rs#L2).