Home

CBUG: An easy to use shell for debugging

Quickstart Guide

1. Download Docker if you haven’t already.
2. Download the latest release of CBUG. Unless you’re very familiar with building from source, we recommend downloading the zip file. Remember to unzip it.
3. Open the Terminal app. To use it, type the path to CBUG before all of your commands. If CBUG was kept in the Downloads folder, you can invoke it with ~/Downloads/cbug/bin/cbug.
4. Use [cbug_path] sync once in your desired directory to begin.
5. Compile your program with CBUG in front of it, and make sure to use CBUG before all subsequent commands. Currently, CBUG uses Valgrind so see documentation on that to debug your code.
6. When done, use clear and remove to clean up the docker.

Congratulations! You can use CBUG!

If you find any bugs, please contact us or submit an issue here.

---

Setting Up zsh Alias

Since cbug is a terminal program, you can set up an alias to quickly call its path instead of typing the program path each time. This can be done with editing the .zshrc file on your Mac. One quick command can create and/or open the file needed.

1. Open the terminal and run nano ~/.zshrc. ~/ specifically looks through the home directory to find/create it. It should look like this (but it might have other text depending on what you've done before):
2. In this editor, # followed by text is a comment. For actual alias, type alias cbug = "PATH", replacing PATH with whatever path you call for cbug. If you use ~/ when calling cbug, replace it with $HOME/.
3. Write the file by pressing control + o.
4. Exit with control + x.
5. Restart the terminal to use cbug by just typing cbug in the terminal.