Skip to content

0x4248/Shell

🐚 Shell++

A simple shell written in C++.

🔨 Building

📝 Dependencies

🛠️ Building using our Makefile

First install the dependencies, then clone the repository and cd into it:

apt install gcc make

To build the shell, run the following commands:

make

🛠️ Building using cmake

Manually

First install the dependencies, then clone the repository and cd into it:

apt install gcc make cmake

To build the shell, run the following commands:

mkdir build
cd build
cmake ..
make

Or run cmake in the root directory:

cmake .
make

Note

The makefile will be changed and should not be put into version control

Using the script

First install the dependencies, then clone the repository and cd into it:

apt install gcc make cmake

To build the shell, run the following commands:

sh tools/build_cmake.sh

You can also clean the repository using the following command:

sh tools/clean_cmake.sh

⚙️ Configuration

This project uses Kconfig to configure the shell. You will need to install kconfiglib to configure the shell.

To install kconfiglib, run the following command:

pip3 install kconfiglib

To configure the shell, run the following command:

make menuconfig

📖 Usage

To run the shell, run the following command:

./shell

✅ OS Support

Linux and MacOS are supported. Windows is not supported.

📝 Licence

This project is licensed under the GNU General Public License v3.0 - see the LICENCE file for details.