Crate shrs

shrs is a framework for building and configuring your own shell in rust.

Example

The most basic shell can be created very easily:

use shrs::prelude::*;

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

    myshell.run().unwrap();
}

For more advanced explanation on features and configuration options, see the shrs book

Modules

• alias
  Shell aliasing
• anyhow
  Re-export of anyhow crate for error handling
• builtin
  Builtin commands
• cmd_output
• completion
  Shell autocompletion
• crossterm
  Re-export of crossterm types
• env
  Environment variables
• history
  Shell history
• hooks
  Shell runtime hooks
• jobs
  Abstraction layer for processes
• keybinding
  Keybinding system
• lang
  Shell command language
• output_writer
• plugin
  Plugin System
• prelude
  use shrs::prelude::* to import most commonly used structs and functions
• prompt
  Collection of utility functions for building a prompt
• prompt_content_queue
• readline
  Readline implementation for shrs
• shell
  Types for internal context of shell
• signal
• state
  Globally accessible state store
• theme
  Configuration for common color values bundled into a theme

Macros

• keybindings
  Macro to easily define keybindings