90s/README.md

69 lines
1.6 KiB
Markdown
Raw Normal View History

2024-01-31 02:02:32 +01:00
# rush
rush is a minimalistic shell for Unix systems written in C.
2024-02-08 20:47:44 +01:00
* 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
2024-02-04 21:30:03 +01:00
[![Valid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/aqnpvvud.png)]()
2024-02-04 21:31:44 +01:00
[![Invalid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/xf80dq0b.png)]()
2024-02-04 21:27:24 +01:00
## Dependencies
2024-01-31 02:02:32 +01:00
- gcc
## Building
2024-01-31 02:02:32 +01:00
```sh
$ make
$ sudo make install
2024-01-31 02:02:32 +01:00
```
## Usage
2024-01-31 02:02:32 +01:00
```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
2024-01-31 02:02:32 +01:00
```
## Features
2024-02-08 13:40:16 +01:00
- No dependencies except a compiler
2024-01-31 02:02:32 +01:00
- 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
2024-02-09 02:18:14 +01:00
- Support for environment variables
2024-02-08 13:40:16 +01:00
- Editing using left and right arrow keys
2024-02-08 21:33:54 +01:00
- !! to repeat last command
2024-02-09 02:18:14 +01:00
- Pipes
- autojump to directorys
- stdin, stdout, stderr redirect
2024-02-11 12:23:49 +01:00
- Background jobs
2024-02-02 17:52:21 +01:00
## Built in commands
2024-02-02 17:52:21 +01:00
- cd
- help
- exit
- history
- export
- source
- j
- bg
2024-01-31 02:02:32 +01:00
## Todo Features
2024-02-11 12:23:49 +01:00
- Tab completion
- Git integration
- Allow arguments with space in double quotes
- Underline file path if it exists
- Aliases
2024-01-31 02:02:32 +01:00
## Credits
2024-01-31 02:02:32 +01:00
- [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/)