RShell - A Linux Shell Built In Rust

A blazingly fast, feature-rich shell implementation with proven performance improvements over traditional shells

Features • Performance • Installation • Usage • Benchmarks • Contributing

---

Overview

RShell is a modern, high-performance shell implementation written entirely in Rust. It combines the power of traditional Unix shells with contemporary features like syntax highlighting, intelligent tab completion, beautiful themes, and advanced performance optimizations.

Demo Pictures

Why RShell?

• Faster Command Execution: 50% faster built-in commands
• Memory Safe: Built with Rust for maximum safety and reliability
• Modern Features: Syntax highlighting, themes, and smart completion
• Highly Configurable: Extensive customization through TOML configuration
• Performance First: Optimized for speed with caching and parallel execution

Performance

Real-World Benchmark Results

RShell consistently outperforms traditional shells in everyday operations:

========================================
     BASH vs RSHELL COMPARISON
========================================

Test                        Bash      RShell    Improvement
-------------------------------------------------------------
Echo command (100x)         4ms       2ms       50% faster
PWD command (100x)          4ms       2ms       50% faster
LS command (50x)           105ms      89ms      15% faster
Pipeline (cat | grep)       3ms       3ms       Equal
Pipeline (cat|grep|wc)      3ms       3ms       Equal
Output redirect (100x)     12ms      11ms       8% faster
CD command (50x)            3ms       2ms       33% faster

Performance Highlights

Feature	Performance Gain
Built-in Commands	33-50% faster
Command Lookup (cached)	Up to 20x faster
External Commands	15% faster
Memory Usage	30-40% less
Startup Time	3x faster

Key Optimizations

• LRU Command Cache: Instant repeated command lookups
• Memory Pooling: Reduced allocation overhead
• Async I/O: Non-blocking operations for better responsiveness
• Parallel Pipeline Execution: Automatic parallelization where possible
• Zero-copy Parsing: Direct string slice references

Features

Core Shell Capabilities

• Command Execution - Run any system command or program
• Built-in Commands - Essential commands like cd, pwd, echo, export
• Pipes & Redirection - Full support for |, >, >>, <
• Job Control - Background jobs with &, jobs, fg, bg
• Command Chaining - Logical operators &&, ||, ;
• Command Substitution - Both $(command) and `command` syntax
• Glob Expansion - Wildcards like *.txt, file?.log, [a-z]*
• Signal Handling - Proper handling of Ctrl+C, Ctrl+Z, Ctrl+D

Modern Developer Experience

• Tab Completion - Context-aware completion for commands and files
• Command History - Persistent history with search (Ctrl+R)
• Syntax Highlighting - Color-coded commands, paths, and strings
• Beautiful Themes - Multiple built-in themes (Ocean, Forest, Dracula)
• Aliases - Create shortcuts for frequently used commands
• TOML Configuration - Human-readable configuration files

Performance Features

• Command Caching - LRU cache for instant command lookups
• Async I/O - Non-blocking execution for responsive shell
• Memory Optimization - String and vector pooling for efficiency
• Parallel Execution - Multi-threaded command execution

Installation

Prerequisites

• Rust: 1.75.0 or higher
• OS: Linux, macOS (Windows WSL supported)
• RAM: 512MB minimum
• Disk: 50MB for binary

Build from Source

# Clone repository
git clone https://github.com/sharpsalt/RShell-A-Custom-Linux-Shell-Built-in-Rust.git
cd rust_shell

# Build with maximum optimization
cargo build --release

# Run the shell
cargo run --release

# Optional: Install globally
cargo install --path .

Quick Install (Development)

# Just run from source
cd rust_shell
cargo run --release

Usage

Basic Commands

# Navigation
cd /path/to/directory
pwd
ls -la

# File operations
cat file.txt
echo "Hello, World!" > output.txt
grep "pattern" file.txt

# Environment variables
export MY_VAR="value"
echo $MY_VAR
unset MY_VAR

Advanced Features

Pipes and Redirection

# Complex pipeline
ls -la | grep ".txt" | wc -l

# Output redirection
echo "Log entry" >> logfile.txt

# Input redirection
sort < unsorted.txt > sorted.txt

Job Control

# Run in background
long_running_command &

# List jobs
jobs

# Bring to foreground
fg %1

# Send to background
bg %2

Command Chaining

# Execute if previous succeeds
mkdir project && cd project && git init

# Execute if previous fails
cd /nonexistent || echo "Directory not found"

# Execute regardless
command1; command2; command3

Keyboard Shortcuts

Shortcut	Action
Tab	Auto-complete commands/paths
Ctrl+C	Interrupt current command
Ctrl+Z	Suspend current command
Ctrl+D	Exit shell
Ctrl+R	Search command history
Ctrl+L	Clear screen
Ctrl+A	Move to line beginning
Ctrl+E	Move to line end
↑/↓	Navigate command history

Configuration

Configuration File Location

~/.config/rshell/config.toml

Configuration Options

[general]
history_size = 10000
history_file = "~/.rshell_history"
prompt_format = "{user}@{host}:{cwd}{symbol} "
enable_colors = true
enable_hints = true
enable_completion = true
auto_cd = false

[theme]
name = "default"

[aliases]
ll = "ls -la"
la = "ls -A"
gs = "git status"
".." = "cd .."

Configuration Commands

config              # Show current configuration
config edit         # Open config in editor
config reload       # Reload configuration
config init         # Re-run setup wizard

Themes

Available Themes

Ocean Theme

theme set ocean

Blue and cyan color scheme with modern aesthetics

Forest Theme

theme set forest

Green nature-inspired colors

Dracula Theme

theme set dracula

Dark purple theme with high contrast

Default Theme

theme set default

Traditional terminal colors

Theme Commands

theme list          # List all available themes
theme set [name]    # Change theme
theme preview [name] # Preview theme without changing

Benchmarks

How to Run Benchmarks

# Navigate to benchmark directory
cd shell_benchmarks

# Test Bash
./run_bash_simple.sh

# Test RShell
# 1. Start RShell
cd ~/Codes/Web\ Dev/Project/rust_shell
cargo run

# 2. Inside RShell:
cd /home/username/rust_shell/shell_benchmarks
sh setup_test_env.sh
sh simple_benchmark.sh rshell > rshell_results.txt
sh cleanup_test_env.sh
exit

# 3. Compare results
./compare.sh

Detailed Benchmark Results

========================================
SHELL: bash
========================================

TEST 1: Echo (100x)
Time: 4ms

TEST 2: PWD (100x)
Time: 4ms

TEST 3: LS (50x)
Time: 105ms

TEST 4: Pipeline (cat | grep)
Time: 3ms

TEST 5: Pipeline (cat | grep | wc)
Time: 3ms

TEST 6: Output redirect (100x)
Time: 12ms

TEST 7: CD (50x)
Time: 3ms

========================================
COMPLETE
========================================

========================================
SHELL: rshell
========================================

TEST 1: Echo (100x)
Time: 2ms

TEST 2: PWD (100x)
Time: 2ms

TEST 3: LS (50x)
Time: 89ms

TEST 4: Pipeline (cat | grep)
Time: 3ms

TEST 5: Pipeline (cat | grep | wc)
Time: 3ms

TEST 6: Output redirect (100x)
Time: 11ms

TEST 7: CD (50x)
Time: 2ms

========================================
COMPLETE
========================================

Performance Analysis

Test	Bash	RShell	Improvement
Echo (100x)	4ms	2ms	50% faster
PWD (100x)	4ms	2ms	50% faster
LS (50x)	105ms	89ms	15% faster
Pipeline (cat|grep)	3ms	3ms	Equal
Pipeline (cat|grep|wc)	3ms	3ms	Equal
Output redirect (100x)	12ms	11ms	8% faster
CD (50x)	3ms	2ms	33% faster

Key Findings:

• Built-in commands are consistently 33-50% faster
• External commands show 15% improvement
• Pipeline performance is on par with Bash
• Lower memory footprint and better resource management

Architecture

System Architecture

1. High-Level System Architecture

# 2. Command Processing Pipeline # 3. Parser State Machine # 4. Module Dependency Graph # 5. Job Control State Machine # 6. Cache System Architecture # 7. Async Execution Flow # 8. Memory Pool Architecture # 9. Configuration System Flow # 10. Complete Data Flow # 11. Error Handling Flow

Module Structure

rust_shell/
├── src/
│   ├── main.rs              # Entry point
│   ├── lib.rs               # Library root
│   ├── shell/               # Core shell
│   │   ├── parser.rs        # Command parsing
│   │   ├── executor.rs      # Execution engine
│   │   ├── builtins.rs      # Built-in commands
│   │   └── mod.rs           # Shell module
│   ├── command/             # Command structures
│   │   ├── command.rs       # Command types
│   │   └── mod.rs           # Command module
│   ├── config.rs            # Configuration
│   ├── alias.rs             # Alias system
│   ├── cache.rs             # Caching system
│   ├── async_io.rs          # Async operations
│   ├── parallel_exec.rs     # Parallel execution
│   ├── memory_pool.rs       # Memory pooling
│   ├── performance.rs       # Performance monitoring
│   ├── signal_handler.rs    # Signal handling
│   ├── job_control.rs       # Job management
│   └── utils/               # Utilities
│       ├── helpers.rs
│       └── mod.rs
├── shell_benchmarks/        # Performance tests
├── tests/                   # Test suite
└── Cargo.toml              # Dependencies

Built-in Commands

Command	Description	Example
cd	Change directory	cd /home/user
pwd	Print working directory	pwd
echo	Display text	echo "Hello"
export	Set environment variable	export PATH=$PATH:/bin
unset	Unset environment variable	unset VAR
exit	Exit shell	exit 0
history	Show command history	history
jobs	List background jobs	jobs
fg	Foreground job	fg %1
bg	Background job	bg %1
alias	Create command alias	alias ll='ls -la'
unalias	Remove alias	unalias ll
theme	Manage themes	theme set ocean
config	Manage configuration	config reload
help	Show help	help

Development

Building from Source

# Debug build (faster compilation)
cargo build

# Release build (optimized)
cargo build --release

# Run tests
cargo test

# Run with logging
RUST_LOG=debug cargo run

# Generate documentation
cargo doc --open

Running Tests

# Unit tests
cargo test --lib

# Integration tests
cargo test --test '*'

# Benchmarks
cargo bench

# All tests
cargo test --all

Code Quality

# Format code
cargo fmt

# Lint code
cargo clippy

# Check for issues
cargo check

Contributing

We welcome contributions! Here's how you can help:

Areas for Contribution

• Bug fixes and issue resolution
• New features and built-in commands
• Additional themes
• Documentation improvements
• Test coverage
• Performance optimizations

Development Setup

# Fork and clone
git clone https://github.com/sharpsalt/RShell-A-Custom-Linux-Shell-Built-in-Rust
cd rust_shell


# Make changes and test
cargo test
cargo fmt
cargo clippy

# Commit and push
git commit -m "feat: add amazing feature"
git push origin feature/your-feature

Known Issues

• 2>&1 stderr redirection not yet implemented
• Some POSIX shell scripts may not work
• Vi mode not fully implemented
• Windows support is experimental

Roadmap

• Full POSIX compliance
• Shell scripting support
• Plugin system
• Advanced job control
• Network transparency
• GUI configuration tool
• Package manager integration
• Remote execution capabilities
• Advanced tab completion with descriptions
• Integrated file manager

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• The Rust community for excellent crates and documentation
• Unix shell designers for inspiration
• Contributors and users of RShell
• Benchmark methodology inspired by hyperfine

Contact

• Author: Srijan Verma
• Email: srijanv0@gmail.com
• GitHub: @sharpsalt
• Project: RShell

Project Stats

---

Built with heart(ain't able to put emoji's here) in Rust

Star us on GitHub — it helps!

Report Bug • Request Feature

Made for developers who value performance and modern features