A shell tool to wrap around a docker container and make compiling and debugging memory easy in a closed environment. This tool is especially designed for those developing on arm systems (e.g. apple silicon) as most memory debugging tools are not built for it.
NOTE: Cbug is currently only tested for Apple Silicon Macs. The x86 macos and linux versions should work, but they are not tested thoroughly. Building for Windows will not work, even from source.
Before installing cbug, make sure that you have installed docker. Cbug is built on docker, and will not run without it.
To install cbug, download the latest release, and unzip the file. To use cbug, either invoke its path directly (i.e. ~/user/cbug-verion/bin/cbug), or add the bin directory to your path.
See the wiki for a more detailed setup guide.
Using cbug is very simple. Simply add the cbug keyword before any command you want to use in the container. Before compiling or running code, however,A make sure to run cbug sync to sync your current directory's files with cbug.
if a container does not currently exist, cbug will automatically spin one up for you
cbug sync
cbug g++ *.cpp
cbug valgrind ./a.out
This happens when code is compiled on your computer, but run in cbug. You must remember to compile the program in cbug
Open the executable (the file in the bin folder of cbug) by right clicking, and clicking open. Once you have opened it for the first time like this, you will be able to run it from the command line.
Displays a list of all commands and flags available to use
Remove all files from current cbug container
Syncs the current working directory with cbug so that all files between the two are identical.
Allows you to configure the default behaviour of cbug.
You can also run
cbug config defaultto restore the default configuration
Removes a cbug container from docker
Cbug will look for updates to itself and the docker container it uses, and download any if available.
Display cbug's version and any other important information
These flags are generally only for passing commands into cbug containers and cbug attach.
Force the container to remain running after executing the command.
Force the container to shutdown after executing the command.
Pause the container after executing the command.
Sync the files between the current working directory and cbug before running the command.
Run this command on a docker container with a different name than default (this default can also be changed with cbug config). This command also works with cbug sync
Force docker to emulate/pass through as a tty shell. This can cause some problems, but if cbug is not displaying the full output of the command or input streaming is not working, this may help. This flag is not available for cbug attach.
Use an arm based cbug container. If the computer is x86, it will emulate the arm environment.
Use an x86 based cbug container. If the computer is arm, it will emulate the x86 environment