Skip to content

Latest commit

 

History

39 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

Windows

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

UNIX

Go to the Release tab and download the latest Linux binary for your libc. Support exists for:

  • x86_64 glibc
  • x86_64 musl-libc
  • aarch64 Android BIONIC
  • Alternative use the universal AppImage, if you don't know your libc.

Building

Check here for the full building guide.

Windows

  1. Clone the project: git clone https://github.com/lce2011/Kruste.git
  2. Go to the directory and build the project: .\scripts\full-build.bat
  3. The Kruste binary now sits inside .\target\release

UNIX

  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. Also give information on what executable you use/how you got the executable (Releases, Building, etc.) and what system you use.

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