Crust Shell Documentation

Welcome to the Crust Shell documentation! This directory contains comprehensive documentation for the Crust Shell project.

📚 Documentation Index

• Overview - Project overview and key features
• Installation - Setup and installation instructions
• User Guide - How to use Crust Shell
• Configuration - Configuring aliases and commands
• API Reference - Technical API documentation
• Architecture - Project structure and design
• Contributing - How to contribute to the project
• Troubleshooting - Common issues and solutions

🚀 Quick Start

1. Navigate to the src directory
2. Run python main.py to start the shell
3. Type about to see version information
4. Type commands or use built-in features like capk <package> for package searching

🔧 Key Features

• Rich Terminal Interface - Beautiful, colorful terminal output using the Rich library
• Git Integration - Shows current repository and branch information in the prompt
• Package Search - Search for packages across multiple package managers with capk
• AI Integration - Ask questions and get help with .question command
• Custom Aliases - Define your own command aliases
• System Information - Built-in commands for disk usage, USB devices, and more

📖 Documentation Structure

Each documentation file covers a specific aspect of the Crust Shell:

• User-focused docs: Overview, Installation, User Guide, Configuration
• Developer-focused docs: API Reference, Architecture, Contributing
• Support docs: Troubleshooting Guide

🤝 Getting Help

• Check the User Guide for common usage patterns
• See Troubleshooting Guide for common issues
• Use the built-in troubleshooting command for AI-assisted problem solving
• Review the API Reference for technical details

---

Crust Shell - A modern, feature-rich terminal shell experience