This project provides a customizable and extensible shell toolkit written in Rust, targeting developers and power users who want to build or modify shell environments. It aims to be hackable and developer-friendly, enabling easy customization of prompts, completions, and the addition of unique features via a plugin system.

How It Works

shrs is built around a ShellBuilder pattern in Rust, allowing programmatic configuration of shell components like prompts and command execution. Its core advantage lies in its Rust implementation, offering memory safety and performance, coupled with a flexible plugin architecture that facilitates community contributions and feature expansion.

Quick Start & Requirements

• Install via cargo install shrs or build from source.
• Run bundled example: git clone https://github.com/MrPicklePinosaur/shrs.git && cd ./shrs/shrs_example && cargo run
• Basic shell creation: Use ShellBuilder in a Rust project.
• Prerequisites: Rust toolchain.
• Documentation: https://mrpicklepinosaur.github.io/shrs/docs/getting-started/introduction/

Highlighted Details

• Completely configurable in Rust (prompt, completions, etc.).
• Plugin system for adding unique features.
• Community plugins include shrs_insulter, shrs_openai, shrs_presence, shrs_sound.

Maintenance & Community

• Active development, API subject to change.
• Community support via Discord: https://discord.gg/XYeMseQrbM
• Contribution guidelines available in documentation.

Licensing & Compatibility

• Dual-licensed under MIT and Apache 2.0.
• Permissive licenses suitable for commercial use and integration into closed-source projects.

Limitations & Caveats

The project is explicitly stated as a work in progress, with APIs prone to frequent changes and potential instability, making it unsuitable for daily use but ideal for prototyping experimental shell features.