vex-tui

command module
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 4, 2025 License: MIT Imports: 6 Imported by: 0

README ยถ

๐Ÿ“Š Vex - Excel Viewer

A beautiful, fast, and feature-rich terminal-based Excel and CSV viewer built with Go.

Go Version License Version

Vex Demo

โœจ Features

๐ŸŽจ Six Beautiful Themes
  • Catppuccin Mocha - Soft pastels, perfect for all-day use
  • Nord - Cool Arctic blues, minimal and focused
  • Rosรฉ Pine - Elegant rose tones, sophisticated
  • Tokyo Night - Vibrant cyberpunk aesthetic
  • Gruvbox - Warm retro colors, comfortable
  • Dracula - Classic high contrast theme
๐Ÿ” Powerful Navigation
  • Vim-style keybindings (hjkl) and arrow keys
  • Jump to any cell (Ctrl+G) with multiple format support
  • Page Up/Down, Home/End
  • Search across all cells and formulas (/)
  • Navigate search results (n/N)
๐Ÿ“‹ Data Operations
  • Copy cell (c) or entire row (C)
  • Export to CSV or JSON
  • Toggle formula display (f)
  • View detailed cell information (Enter)
๐Ÿ“Š Live Data Visualization
  • Bar charts
  • Line charts
  • Sparklines
  • Pie charts
๐Ÿ“‘ File Support
  • Excel files (.xlsx, .xlsm, .xls)
  • CSV files
  • Multiple sheets with Tab navigation
  • Formula display and evaluation
  • Large file optimization with lazy loading

๐Ÿš€ Installation

Using go install
go install github.com/CodeOne45/vex-tui@latest
Build from Source
# Clone the repository
git clone https://github.com/CodeOne45/vex-tui.git
cd vex-tui

# Install dependencies
go mod download

# Build
go build -o vex .

# Optional: Install globally
go install
Download Binary

Download pre-built binaries from the releases page.

๐Ÿ“– Usage

# Basic usage
vex data.xlsx

# With a specific theme
vex report.csv --theme nord

# Short flag
vex sales.xlsx -t tokyo-night

โŒจ๏ธ Keyboard Shortcuts

Navigation
  • โ†‘โ†“โ†โ†’ or hjkl - Navigate cells
  • Page Up/Down - Scroll by page
  • Ctrl+U/D - Alternative page scroll
  • Home/End or 0/$ - First/last column
  • g/G - First/last column
  • Tab/Shift+Tab - Next/previous sheet
Search & Actions
  • / - Search (vim-style)
  • n/N - Next/previous result
  • Ctrl+G - Jump to cell
  • Enter - View cell details
  • c - Copy cell
  • C - Copy entire row
  • f - Toggle formula display
  • e - Export sheet
  • t - Theme selector
  • ? - Toggle help
  • q or Ctrl+C - Quit
Data Visualization

Step 1: Select Data Range

  1. Navigate to your data
  2. Press 'V' (shift+v) to start selection
  3. Move cursor to select range (arrows/hjkl)
  4. Press 'V' again to finish selection

Step 2: Visualize

  1. Press 'v' (lowercase) to open visualization
  2. Press 1-4 to switch between chart types:
    • 1: Bar Chart
    • 2: Line Chart
    • 3: Sparkline
    • 4: Pie Chart
  3. Press Esc to close

๐Ÿ—๏ธ Project Structure

vex-tui/
โ”œโ”€โ”€ main.go                 # Application entry point
โ”œโ”€โ”€ internal/
โ”‚   โ”œโ”€โ”€ app/               # Application logic
โ”‚   โ”‚   โ”œโ”€โ”€ model.go       # State management
โ”‚   โ”‚   โ”œโ”€โ”€ update.go      # Event handling
โ”‚   โ”‚   โ”œโ”€โ”€ view.go        # Rendering logic
โ”‚   โ”‚   โ””โ”€โ”€ keys.go        # Keybindings
โ”‚   โ”œโ”€โ”€ loader/            # File I/O operations
โ”‚   โ”‚   โ””โ”€โ”€ loader.go
โ”‚   โ”œโ”€โ”€ theme/             # Theme management
โ”‚   โ”‚   โ””โ”€โ”€ theme.go
โ”‚   โ””โ”€โ”€ ui/                # UI utilities
โ”‚       โ””โ”€โ”€ ui.go
โ””โ”€โ”€ pkg/
    โ””โ”€โ”€ models/            # Data models
        โ””โ”€โ”€ models.go

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development Setup
# Clone the repository
git clone https://github.com/CodeOne45/vex-tui.git
cd vex

# Install dependencies
go mod download

# Run tests
go test ./...

# Build
go build -o vex .
Code Style

This project follows standard Go conventions:

  • Run go fmt before committing
  • Follow Effective Go guidelines
  • Write clear commit messages

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgments

๐Ÿ”’ Security

If you discover a security vulnerability, please send an email to security@vex-tui.dev. All security vulnerabilities will be promptly addressed.

๐Ÿ“ฎ Contact


Made with โค๏ธ for terminal enthusiasts everywhere.

Documentation ยถ

The Go Gopher

There is no documentation for this package.

Directories ยถ

Path Synopsis
internal
app
ui
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL