boltshell 0.1.1

Lightweight shell made purely in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

# Bolt Shell


**Bolt is a terminal shell made purely in Rust**

---

## Introduction


Bolt Shell is a modern, lightweight, and efficient terminal shell designed for developers and users who value performance and simplicity. Built entirely in Rust, Bolt leverages Rust's safety and concurrency features to deliver a reliable and fast command-line experience.

## Key Features


- **Fast and Lightweight**: Optimized for speed and minimal resource usage.
- **Windows Support**: Currently available for Windows systems (for now).
- **User-Friendly**: Includes commands suitable for beginners and power users alike.
- **Safety First**: Built with Rust to minimize crashes and memory-related bugs.

## Installation


### From Source

1. Ensure you have Rust installed on your system. If not, download it from [rust-lang.org](https://www.rust-lang.org/).
2. Clone the repository:
   ```powershell
   git clone https://github.com/usebolt/boltshell.git
   cd boltshell
   ```
3. Build the project:
   ```powershell
   cargo build --release
   ```
4. Run the shell:
   ```powershell
   .\target\release\boltshell.exe
   ```

### Precompiled Binaries

Precompiled binaries will be available soon for easier installation. Stay tuned!

## Usage


Once installed, launch Bolt Shell by running the following command:
```powershell
boltshell
```

### Basic Commands

- Navigate directories: `cd`
- List files: `ls`
- Execute programs: `program_name [arguments]`
- Exit the shell: `exit`

### Prompt

Bolt Shell features a dynamic prompt displaying the current user, hostname, and working directory, with visual distinctions for home (`~`) and root (`#`) directories.

## Contributing


Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a new branch for your feature or bug fix:
   ```powershell
   git checkout -b feature-name
   ```
3. Commit your changes:
   ```powershell
   git commit -m "Add feature-name"
   ```
4. Push to your branch:
   ```powershell
   git push origin feature-name
   ```
5. Open a pull request.

## License


Bolt Shell is released under the MIT License. See the [LICENSE](LICENSE) file for more details.

## Acknowledgments


Special thanks to the Rust community for providing incredible tools and resources, and to all contributors who have helped shape Bolt Shell.

---

**Start using Bolt Shell today and experience the power of Rust in your terminal!**