rithikasilva / shrs Goto Github PK

The rusty shell toolkit for hackers

• hackable: almost every aspect of the shell should be easily customizable and extendable
• developer friendly: well documented and easy to contribute to
• rusty: implemented in and configurable in rust

DISCLAIMER: shrs is currently very much a work in progress, the API is subject to change frequently and things are prone to breaking. It currently may not be suitable for daily use, but is great for prototyping any experimental shell features you dream up with!

Here are what makes shrs special:

• Completely configurable in rust (including your prompt, completions and more!)
• Plugin system (community maintained plugins that add unique features)

To get a taste of what shrs is capable of, without any configuration, you can run the example shrs_example shell that is bundled by running:

git clone https://github.com/MrPicklePinosaur/shrs.git
cd ./shrs/shrs_example
cargo run

To get started with building your own shell, it's as easy as creating a new cargo project with:

use shrs::prelude::*;

fn main() {
    let myshell = ShellBuilder::default()
        .build()
        .unwrap();

    myshell.run();
}

See the developer documentation for more in depth information.

If you encounter and bugs are have any feature requests, please don't hesitate to leave an issue! Also take a look at the section for contributors in the documentation.

List of cool 3rd part plugins and community built shells can be found in awesome_shrs. Some notable examples includes

• shrs_insulter: port of bash insulter
• shrs_openai: chatgpt for your shell
• shrs_presence: show shrs on discord presence
• shrs_sound: play sounds in your shell