# ClearShell
A shell environment built with the goal of being simple, clean, and easy to use

> Note: This program is currently available as a __pre-release__ program, bugs are expected and this is not ready for use in critical systems.

---

# Planned Features
- [ ] TrueColor translation
- [ ] Modern TOML based configuration, no more guesswork
- [ ] Easy to learn scripting language
- [ ] Helpful help commands
- [ ] Well documented, in a modern format
- [ ] built-in shell customization

---

# Roadmap
- [ ] March 1st 2021 - first "public" build made available
- [ ] March 10th 2021 - halfway to common command parity with bash (cd, ls, echo, etc...)
- [ ] April 1st 2021 - First alpha release candidate - no scripting support
- [ ] April 30th 2021 - Initial scripting release candidate
- [ ] May 15th 2021 - Common command parity with Bash
- [ ] May 31st 2021 - Beta release candidate
- [ ] June 10th 2021 - Primary release candidate and announcements
- [ ] June 20th 2021 - Bugfix release candidate

---

# Documentation

Please visit our [website](https://altriusrs.github.io/clearshell/) for documentation

---

# Installation
## Downloads:
### x86_64 (64 bit Intel/AMD) Windows
For 64 bit Windows computers
- [Binary](https://github.com/AltriusRS/clearshell/raw/main/binaries/x86_64-pc-windows-gnu/clearshell.exe)

### x86_64 (64 bit Intel/AMD) MacOS
For 64 bit Intel/AMD based MacOS devices
- [Binary](https://github.com/AltriusRS/clearshell/raw/main/binaries/x86_64-apple-darwin/clearshell)

### x86_64 (64 bit Intel/AMD) Linux
For 64 bit Intel/AMD based Linux systems
- [Binary](https://github.com/AltriusRS/clearshell/raw/main/binaries/x86_64-unknown-linux-gnu/clearshell)

### x86_32/i386 (32 bit Intel/AMD) Linux
For 32 bit Intel/AMD based Linux systems
- [Binary](https://github.com/AltriusRS/clearshell/raw/main/binaries/i686-unknown-linux-gnu/clearshell)

---

## Via [crates.io](https://crates.io/crates/clearshell)
1. Install and set up Rust on your computer, ensuring all required steps have been taken.
We recommend [this tutorial on TheNewStack](https://thenewstack.io/tutorial-installing-rust/) for Windows users. For MacOS and Linux users, you should be able to install everything you need using [rustup](https://rustup.rs/)

2. Once everything is set up open your terminal and type:
```shell
cargo install clearshell
```

3. Sit back and wait for ClearShell to install!

---
## Via Package Managers
> Coming Soon!