Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shshemi/tabiew
A lightweight TUI app to view and query CSV files
https://github.com/shshemi/tabiew
Last synced: 25 days ago
JSON representation
A lightweight TUI app to view and query CSV files
- Host: GitHub
- URL: https://github.com/shshemi/tabiew
- Owner: shshemi
- License: mit
- Created: 2024-04-27T16:21:19.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-05-21T20:58:17.000Z (25 days ago)
- Last Synced: 2024-05-21T21:17:45.780Z (25 days ago)
- Language: Rust
- Homepage:
- Size: 644 KB
- Stars: 38
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-ratatui - tabiew - A lightweight TUI app to view and query CSV files. (💻 Apps / 🚀 Productivity and Utilities)
- awesome-rust - Tabiew
README
# Tabiew
Tabiew is a lightweight, terminal-based application to view and query delimiter separated value formatted documents, such as CSV and TSV files.
## Features
- 📊 **Table View**: Explore your data with an easy-to-navigate table view.
- 🔍 **Detailed View**: Dive deep with a detailed view of individual records.
- 🛠️ **SQL Query Capability**: Utilize SQL for powerful data querying, such as filtering, sorting, and aggregations.
- ⌨️ **Vim Inspired Keybindings**: Navigate through your data effortlessly using Vim-style keybindings.
## Keybindings️
|Key Combination|Functionality|
|-|-|
| `v`| Toggle detailed view|
| `k` or `Arrow Up`| Move up in the table or scroll up in detailed view|
| `j` or `Arrow Down`| Move down in the table or scroll down in detailed view|
| `h` or `Arrow Left`| Move to the previous item in detailed view|
| `l` or `Arrow Right`| Move to the next item in detailed view|
| `Page Up` or `Ctrl+b`| Move one page up|
| `Page Down` or `Ctrl+f`| Move one page down|
| `Ctrl+u`| Move up half a page|
| `Ctrl+d`| Move down half a page|
| `Home` or `g`| Move to the first row|
| `End` or `G`| Move to the last row|
| `q`| Quit|
| `:`| Command mode|
## Commands
|Command|Example|Description|
|-|-|-|
|`:Q` or `:query`|`:Q SELECT * FROM df`| Query the data in Structured Query Language (SQL). The table's name is 'df'|
|`:S` or `:select`| `:S price, area, bedrooms, parking`|Query the original for selected columns|
|`:F` or `:filter`| `:F price < 20000 AND bedrooms > 4`|Query the original dataset where the condition(s) match|
|`:O` or `:order`| `:O area`|Query the original data frame ordering by requested columns|
|`:goto`| `:goto 10`| Jumps to the specified line index|
|`:moveup`| `:moveup 10`| Jump a specified number of lines up|
|`:movedown`| `:movedown 10`| Jump a specified number of lines down|
|`:q` or `:quit` |`:q`| Quit Tabiew|
|`:reset`| `:reset`| Reset the table to the original data frame|
|`:help`| `:help`| Show help menu|
## Installation
There are various ways to install Tabiew:
### Debian-based
Download the `.deb` package from the [GitHub releases page](https://github.com/shshemi/tabiew/releases) and:
```bash
sudo dpkg -i
```
### RPM-based
Download the `.rpm` package from the [GitHub releases page](https://github.com/shshemi/tabiew/releases) and:
```bash
sudo rpm -i
```
### Windows
Download the `.exe` file from the [GitHub releases page](https://github.com/shshemi/tabiew/releases) and place it in a directory that is included in system's PATH environment variable.
**Disclaimer:** The Windows version may experience performance lag.
### Cargo
Install Tabiew from *Crates.io*:
```bash
cargo install tabiew
```
### Build from Source
Ensure you have the 1.80.0-nightly (or higher) version of Rust installed, then:
```bash
git clone https://github.com/shshemi/tabiew.git
cd tabiew
rustup override set nightly
cargo build --release
cp ./target/release/tabiew
```
## Usage
Start Tabiew with `tw`
```bash
tw
```
Options:
- `--no-header`: Use this option if the CSV file does not contain a header row.
- `--ignore-errors`: Ignore parsing errors while loading the CSV file.
- `--infer-schema`: Set the schema inference method. Options are no, fast, full, and safe.
- `--quote-char`: Set the quote character.
- `--separator`: Set the separator character.
## Contributing
Contributions are welcome! Please fork the repository and submit pull requests with your features and bug fixes.
## License
This project is licensed under the MIT License - see the LICENSE file for details.