Simple Shell written in C & Bash. 💎

🐔 ** Menu ** 🐔
🔍Description - Description. 🔍
❕ Synopsis - Synopsis. ❕
📃 Allowed functions - Allowed functions. 📃
📢 Requirements - Requirements. 📢
🐺 File descriptor - File descriptor. 🐺
🔨 Installation - Installation. 🔨
✨ Examples - Examples. ✨
🐭 Bugs - Known bugs. 🐭

---

Description 🔍

This is a school project which goal is to mirror the sh command-line interpreter (shell), written by Ken Thompson in a limited scope but on a simpler way.

Synopsis ❕

This version of the shell has a collection of custom built-in commands along with the functionality of running scripts in the the various paths on a given operating system.

List of allowed functions and system calls 📃

• access (man 2 access)
• chdir (man 2 chdir)
• close (man 2 close)
• closedir (man 3 closedir)
• execve (man 2 execve)
• exit (man 3 exit)
• _exit (man 2 _exit)
• fflush (man 3 fflush)
• fork (man 2 fork)
• free (man 3 free)
• getcwd (man 3 getcwd)
• getline (man 3 getline)
• getpid (man 2 getpid)
• isatty (man 3 isatty)
• kill (man 2 kill)
• malloc (man 3 malloc)
• open (man 2 open)
• opendir (man 3 opendir)
• perror (man 3 perror)
• read (man 2 read)
• readdir (man 3 readdir)
• signal (man 2 signal)
• stat (man 2 stat)
• lstat (man 2 lstat)
• fstat(man 2 fstat)
• strtok (man 3 strtok)
• wait (man 2 wait)
• waitpid (man 2 waitpid)
• wait3 (man 2 wait3)
• wait4 (man 2 wait4)
• write (man 2 write)

---

Requirements 📢

This project was designed to be runned in Ubuntu 14.04 LTS linux environment and as** to be compiled** using the GNU compiler collection v. gcc 4.8.4 with the following flags: -Wall, -Werror, -Wextra, -pedantic

---

File descriptor 🐺

File	Brief description
AUTHORS	AUTHORS - List that contents the contributors to this project.
_prompt.c	_prompt.c - Function that writes a message in the main prompt.
_putchar.c	_putchar.c - Function that writes a character to standard input.
_strcat.c	_strcat.c - Function that concatenates two strings.
_strcmp.c	_strcmp.c - Function that compares two strings.
_strcpy.c	_strcpy.c - Function that creates a copy of a string.
_strlen.c	_strlen.c - Function that gets the length of a string.
get_strseq.c	get_strseq.c - Function that takes a sequence from an interval then copies it into a string.
authors_gen.sh	authors_gen.sh - Bash script that generates a file containing the authors of this project.
compile	compile - Bash script that compiles the entire project for easier usage.
env_built.c	env_built.c - Function that handles the enviroment built-in command.
exit_control.c	exit_control.c - Function that handles the exit phase of the project and writes a message accordingly.
find_strseq.c	find_strseq.c - Function that finds the index of a separator.
find_path.c	find_path.c - Function that resolves the PATH to a command. For instance, cmd.
print_env.c	print_env.c - Function that prints out the enviroment. For instance, cmd.
shell.c	shell.c - Main function of the project.
shell.h	shell.h - Main header file containing all the prototypes and libraries required for this program.
_strtok.c	_strtok.c - Function that breaks a string into a series of tokens.
man_1_simple_shell	man_1_simple_shell - Our simple_shell manual page.

🔼 - Back to the top - Go back to the top. 🔼

---

Installation 🔨

1. Clone this repository in your personal computer or machine with the following command: git clone https://github.com/SrDri/simple_shell.git

2. Go to the project s folder using the following command: cd simple_shell

3. Compile the project using our sh script as shown below: ./compile

4. Run the exectuable that was created on the previous step as following: ./hsh

5. Bare in mind that you can also run this program in non-interactive mode as following: echo "pwd" | ./hsh

---

Examples ✨

Interactive mode

If everything worked as supposed to, you should be able to use and see the program s command prompt as shown below:

$ ./hsh

$ ls -l
total 108

-rw-rw-r-- 1 vagrant vagrant   161 Apr  2 05:30 AUTHORS
-rw-rw-r-- 1 vagrant vagrant  6866 Apr 10 08:01 README.md
-rw-rw-r-- 1 vagrant vagrant   150 Apr  9 02:01 _prompt.c
-rw-rw-r-- 1 vagrant vagrant   247 Apr  5 09:06 _putchar.c
-rw-rw-r-- 1 vagrant vagrant   320 Apr  8 05:49 _strcat.c
-rw-rw-r-- 1 vagrant vagrant   502 Apr  9 04:31 _strcmp.c
-rw-rw-r-- 1 vagrant vagrant   302 Apr  5 09:04 _strcpy.c
-rw-rw-r-- 1 vagrant vagrant   225 Apr  9 02:01 _strlen.c
-rw-rw-r-- 1 vagrant vagrant   524 Apr 10 07:59 _strtok.c
-rw-rw-r-- 1 vagrant vagrant   304 Apr 10 01:20 env_built.c
-rw-rw-r-- 1 vagrant vagrant   326 Apr  9 03:29 exit_control.c
-rw-rw-r-- 1 vagrant vagrant   686 Apr 10 08:02 find_strseq.c
-rw-rw-r-- 1 vagrant vagrant  1418 Apr 10 08:02 findpath.c
-rw-rw-r-- 1 vagrant vagrant   534 Apr 10 08:02 get_strseq.c
-rw-rw-r-- 1 vagrant vagrant   192 Apr 10 00:15 print_env.c
-rw-rw-r-- 1 vagrant vagrant   783 Apr 10 01:24 shell.c
-rw-rw-r-- 1 vagrant vagrant   766 Apr 10 01:04 shell.h

Non-interactive mode

echo "pwd" | ./hsh
/home/vagrant/simple_shell

---

Bugs 🐭

• No known bugs at compiling time (April 11, 2021). However, if you find any, please report it to us!

---

Code Contributors 💩

• Juan Jose Carabali Twitter | Email.
• Carlos Galeano Twitter | Email.

---

🔼 - Back to the top - Go back to the top. 🔼