Skip to content

Latest commit

 

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kruste - Keyboard-based Rusty Editor

Kruste is an command-line, keyboard only text editor written in Rust using Ratatui & Crossterm.


Installation & Building

Windows Go to the Release tab and download the latest kruste.exe

UNIX As there aren't any pre-built binarys for MacOS, Linux or any UNIX-like System, you need to built thhe editor from source:

  1. Clone the project: git clone https://github.com/lce2011/Kruste.git
  2. Go to the directory and build the project: cargo build --release
  3. The Kruste binary now sits inside ./target/release/ or ./target/debug/, incase you built without the --release flag.

Open a file

kruste <path>

Note

If the file at the given path doesn't exist, Kruste automatically creates the file.


Customization

Kruste will look for an custom configuration at the path set in the KRUSTE_CONFIG enviroment variable.

I recommend using the following location for your Kruste configuration:

Windows C:\Users\<user>\.config\kruste\config.json

UNIX ~/.config/kruste/config.json

For the full customization docs, see here

Warning

Kruste doesn't automatically generate any config.json file, even if it says, it uses the default config. The actual config.json has to be created seperatly.


Bugs & Issues

If you have a bug, please open up an Issue and describe, what happened and how to replicate the bug.

About

A command-line, keyboard-only code editor written in Rust using Ratatui & Crossterm.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages