77 lines
2 KiB
Markdown
77 lines
2 KiB
Markdown
# rush
|
|
|
|
rush is a minimalistic shell for Unix systems written in C.
|
|
|
|
* Disclaimer: This project is for me to learn to write Unix syscalls, code might be inefficient, feel free to point out the mistakes and open a issue for that!
|
|
|
|
## Preview
|
|
[]()
|
|
[]()
|
|
|
|
## Dependencies
|
|
- gcc
|
|
|
|
## Building
|
|
```sh
|
|
$ make
|
|
$ sudo make install
|
|
```
|
|
|
|
## Usage
|
|
```sh
|
|
$ ./rush
|
|
|
|
# > to redirect stdout
|
|
# < to redirect stdin
|
|
# 2> to redirect stderr
|
|
# >> to append to file
|
|
# & to run command in background
|
|
# | to pipe
|
|
# !! to repeat last command
|
|
# >& to redirect both stdout and stderr
|
|
```
|
|
|
|
## Features
|
|
- No dependencies except a compiler
|
|
- Showing current time and directory with custom color
|
|
- Syntax highlighting on valid commands using ANSI colors
|
|
- History navigation using up and down keys with history command
|
|
- Support for environment variables
|
|
- Editing using left and right arrow keys
|
|
- !! to repeat last command
|
|
- Pipes
|
|
- autojump to directorys
|
|
- stdin, stdout, stderr redirect
|
|
- Background jobs
|
|
|
|
## Built in commands
|
|
- cd
|
|
- help
|
|
- exit
|
|
- history
|
|
- export
|
|
- source
|
|
- j
|
|
- bg
|
|
|
|
## Notes
|
|
- History is either saved in HOME or XDG_CONFIG_HOME if it is defined
|
|
|
|
## Todo Features
|
|
- Tab completion
|
|
- Git integration
|
|
- Allow arguments with space in double quotes
|
|
- Underline file path if it exists `echo -e "\033[4mabc\033[0m"`
|
|
- Aliases
|
|
|
|
# Contributions
|
|
Contributions are welcomed, feel free to open a pull request.
|
|
|
|
# License
|
|
This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/rush/blob/master/LICENSE) for more information.
|
|
|
|
## Credits
|
|
- [Tutorial - Write a shell in C](https://brennan.io/2015/01/16/write-a-shell-in-c/)
|
|
- [dash](https://github.com/danishprakash/dash)
|
|
- [Shell assignment](https://www.cs.cornell.edu/courses/cs414/2004su/homework/shell/shell.html)
|
|
- [khol](https://github.com/SanketDG/khol/)
|