lk-inside

Crates.iolk-inside
lib.rslk-inside
version0.3.1
created_at2025-11-24 23:18:59.024236+00
updated_at2025-11-24 23:18:59.024236+00
descriptionA terminal user interface (TUI) application for interactive data analysis.
homepage
repositoryhttps://github.com/your_repo/lk-inside
max_upload_size
id1948887
size322,871
(cristiano-s-r-filho)

documentation

README

Look Inside - A Data Analysis CLI Tool (Version 0.3.1)

"Look Inside" is a powerful command-line interface (CLI) tool written in Rust, designed for efficient data analysis and visualization directly within your terminal. It provides a robust set of features for inspecting, filtering, and performing statistical analysis on various datasets, now with an enhanced and intuitive text-based user interface (TUI).

Features

  • Interactive, Responsive & Themed TUI: Navigate and interact with your data using a highly responsive terminal user interface, now featuring a consistent color theme, clear visual feedback for interactive elements (like input fields), and optimized rendering for a smooth experience.
  • Data Loading: Load data from various sources, including CSV and JSON.
  • Data Inspection: View datasets in a paginated, scrollable table format.
  • Statistical Analysis: Generate descriptive statistics for numerical columns, null value analysis, and histograms.
  • Data Filtering: Apply advanced filters to narrow down your dataset for focused analysis with a guided input system.
  • Workspace Management: Save and load your entire application state for seamless continuation of work.
  • Visualizations: Improved terminal-based visualizations, including heatmaps with better color gradients.
  • Extensible: Modular design allowing for easy addition of new data sources, analysis methods, and visualizations.

Getting Started

Prerequisites

To build and run "Look Inside", you need to have the following installed:

  • Rust: Install Rust
  • Cargo: Rust's package manager (comes with Rust installation).

Installation

  1. Clone the repository:

    git clone https://github.com/your-repo/lk-inside.git # Replace with actual repo URL
    cd lk-inside
    
  2. Build the project:

    cargo build --release
    
  3. Run the application:

    cargo run --release
    

    Alternatively, you can run the compiled binary:

    ./target/release/lk-inside
    

Usage

Upon launching "Look Inside", you will be greeted by a start menu. Navigate using your keyboard. The bottom bar provides context-sensitive help and keybindings for the current screen.

For detailed usage instructions, including all keybindings and screen-specific actions, please refer to our comprehensive Documentation.

Global Keybindings Quick Reference

  • Alt+Q: Return to the Start Menu.
  • Ctrl+S: Save Current Workspace.
  • Ctrl+O: Load Workspace.
  • ?: Toggle the Help screen.
  • Esc: Exit the application.

Example: Loading and Analyzing a CSV file

cargo run --release -- examples/sample_data.csv

This command will directly load sample_data.csv and open the data view, ready for analysis.

Contributing

We welcome contributions to "Look Inside"! Please see our CONTRIBUTION.md for guidelines on how to submit pull requests, report issues, and generally help improve the project.

License

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

Contact

For questions, feedback, or support, please open an issue on our GitHub repository.

Commit count: 0

cargo fmt