Home
Welcome to the wizsh wiki! 🧙
This project was initially created as a final project for Harvard's CS50 course! Be sure to check out the CS50 course here. It was great!
Wizsh was started in October of 2022 by Leithen Crider. It was initially created as a project to get a better understanding of the C programming language. This was Leithen's first real C project, other than the CS50 problem sets. The hope is that this project goes beyond CS50 and eventually becomes a fully featured shell that could realistically be used by professionals.
There are a lot of improvements to be made so please, open an issue or create a PR!
PREFACE: Wizsh was built on an M1 Mac with no other systems in mind! This means that there are likely issues when attempting to build and run this on any x86 machine. This would be a great issue to contribute to!
These instructions assume that you have installed homebrew and all other dependencies. In most cases, the command below will install all the packages you will need for this app.
brew install libgit2 pkg-config libssh2 openssl
To use wizsh, first install the latest release.
Next, simply run the binary wizsh located in the /bin directory.
To run wizsh locally, you will first need to clone the repository.
Next, navigate to the wizsh directory. Typically just cd wizsh from wherever the clone command was run.
To build the binaries you will first need to run make build. This created the object and binary directories.
Use the command make to build to binary. It is usually best to run a make clean first to make sure you are starting a fresh build.
Run the binary by using the command bin/wizsh. This is the same as cd bin && wizsh.
Be sure to check out the wiki for information on commands!
Wizsh is very open to contributions! If you have a feature request, or bug report, please open an issue with the applicable tag. If you would like to simply create a feature, fork the repository and add in your changes. Then submit a pull request which will be reviewed and eventually mergered if it meets all contribution requirements.
I would be absolutely thrilled to contiue working on this with other developers. If you have noticed a long period of inactivity, feel free to reach out to me at the link below to get the current status of this project.
A handful of libraries were used to create this project. Without them, a lot of features would not have been possible. A list of all included libraries can be found below with links to their websites/documentation.