Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.41 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.41 KB
Raw

CacTui

CacTui is a terminal-based Excel clone written in Rust. It leverages vim motions for efficient navigation and editing, providing a powerful and familiar interface for users who are comfortable with vim.

Features

  • Cac Language: A domain-specific language to run Excel-like expressions.
  • Vim-like Navigation: Navigate through cells using vim motions.
  • Multiple Modes: Switch between Normal, Insert, Visual, Command, and Exit modes.
  • Terminal-Based: Run entirely in the terminal, making it lightweight and fast.

Installation

To install CacTui, you need to have Rust and Cargo installed on your system. You can install Rust using rustup:

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Once Rust is installed, clone the repository and build the project:

$ git clone https://github.com/vkobinski/CacTui.git
$ cd CacTui
$ cargo build --release

Usage

To run CacTui, use the following command:

$ cargo run --release

Modes

The Cac Language

CacTui includes a domain-specific language called Cac Language for running Excel-like expressions. This language allows you to perform calculations directly within cells using familiar syntax.

Examples

  • Basic Arithmetic: =A1 + B2
  • Functions: =SUM(A1:A10)
  • Conditional Expressions: =IF(A1 > 10, "High", "Low")
  • Range: =A1:A10, get values from A1 to A10

The Cac Language supports a variety of functions and operations, making it a powerful tool for data manipulation and analysis within the terminal.

  • Normal Mode: Default mode for navigation.
  • Insert Mode: Mode for editing cell values.
  • Visual Mode: Mode for selecting multiple cells.
  • Command Mode: Mode for executing commands.
  • Exit Mode: Mode to exit the application.

Key Bindings

  • h, j, k, l: Move left, down, up, and right respectively.
  • i: Enter Insert mode.
  • v: Enter Visual mode.
  • :: Enter Command mode.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any features, bug fixes, or improvements.

License

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

Acknowledgements

  • Inspired by vim and its powerful navigation capabilities.
  • Built with Rust for performance and safety.

Enjoy using CacTui!