Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milandekruijf/minishell
https://github.com/milandekruijf/minishell
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/milandekruijf/minishell
- Owner: milandekruijf
- License: mit
- Created: 2024-10-18T15:54:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-12T15:04:52.000Z (3 months ago)
- Last Synced: 2024-11-12T15:35:44.619Z (3 months ago)
- Language: C
- Size: 169 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
Minishell
Minishell is a collaborative team project developed as part of the curriculum at 42 School, aimed at creating a basic shell program in C. This project serves as a practical exercise in systems programming, enabling students to deepen their understanding of operating system concepts and the C programming language.
## Usage
### Prerequisites
Clone the repository to your local machine using the following command in the terminal.
```sh
git clone https://github.com/milandekruijf/minishell.git && cd minishell
```
### Compiling
In order to compile the Minishell program, run the following command in the project root directory.
```sh
make
```
*Compiles using the `cc` compiler with the flags `-Wall`, `-Wextra`, and `-Werror`.
### Running
After compiling, the executable `minishell` will be created in the `/out` directory. Run the executable to start Minishell.
```sh
./out/minishell
```
*You can also just use `make run` to compile and run the program in one command.*
### Debugging
In order to debug the program, you must have [Valgrind](https://valgrind.org) installed. Run the following command in the project root directory to run in debug mode.
```sh
make debug
```
*This will recompile everything with the `-g3` flag and run the program using `valgrind` with the following flags: `--leak-check=full`, `--show-leak-kinds=all`, and `--track-origins=yes`*
### Testing
Run the following command in the project root directory.
The tests are located in the `/tests` directory.
```sh
make test
```
*This will recompile everything with the `-g3` flag and run the program using `valgrind` with the following flags: `--leak-check=full`, `--show-leak-kinds=all`, and `--track-origins=yes`*
I just want to compile the tests
If you only want to compile the tests executable, run the following command in the project root directory.
```sh
make tests
```
*This won't compile with any extra flags.*
### Linting
In order to lint the project, you must have [Norminette](https://github.com/42School/norminette) installed. Run the following command in the project root directory to lint the project.
```sh
make lint
```
*The `/tests` directory is excluded from linting as it contains test files that do not have to adhere to the 42 coding standards.*
## Features
Minishell is a lightweight shell program inspired by Bash, designed to provide essential shell functionalities. Below are the key features supported by Minishell.
### General
- Prompt Display: A user-friendly prompt that indicates readiness for commands.
- Command History: Navigate through previously executed commands using the up and down arrow keys.
- System Executables: Execute standard system commands like `ls`, `cat`, `grep`, etc.
- Local Executables: Run local executables from the current working directory.
### Builtin Commands
Minishell supports the following built-in commands:
- `echo`: Displays messages, with an option for no trailing newline (`-n`).
- `cd`: Changes the current directory using either relative or absolute paths.
- `pwd`: Outputs the current working directory (no options).
- `export`: Lists environment variables without options.
- `unset`: Removes environment variables without options.
- `env`: Displays the current environment variables without options or arguments.
- `exit`: Terminates Minishell, with an optional exit status.
### Input/Output Management
- Pipes (`|`): Redirects the output of one command to the input of another, enabling command chaining.
- Redirections:
- `>`: Redirects output to a file (overwriting).
- `>>`: Redirects output to a file (in append mode).
- `<`: Redirects input from a file.
- `<<`: Allows for here-document input, prompting the user for input until the specified delimiter is reached. This input is redirected to the command but does not update command history.
### Environment Variable Expansion
- Support for environment variable expansion, allowing variables like `$USER` or custom variables (e.g. `$MS_PROMPT`) to resolve to their corresponding values.
- The special variable `$?` returns the exit status of the most recently executed foreground pipeline.
### User Keyboard Signals
- User keyboard signals:
- `Ctrl-C`: Cancels the current command and displays a new prompt.
- `Ctrl-D`: Exits Minishell gracefully.
- `Ctrl-\`: Has no effect in the Minishell environment.
### Limitations
Minishell does not support the following:
- Escape character (`\`)
- Command separators (`;`)
- Logical operators (`&&`, `||`)
- Wildcards (`*`)
## Acknowledgements
- [Acutest](https://github.com/mity/acutest): A minimal C unit testing framework used for testing individual functions.
- [Valgrind](https://valgrind.org/): A memory debugging tool used for detecting memory leaks and errors.
- [Norminette](https://github.com/42School/norminette): Used for linting the project according to the 42 coding standards.
- [42](https://42.fr): The educational institution that inspired and supported the development of this project.
- [Codam](https://www.codam.nl): The partner school of 42 in the Netherlands, where the project was developed.