cutter/README.md

Cutter

A Qt and C++ GUI for radare2 reverse engineering framework (originally Iaito)

Screenshot

Disclaimer

Cutter is not aimed at existing radare2 users. It instead focuses on those whose are not yet radare2 users because of the learning curve, because they don't like CLI applications or because of the difficulty/instability of radare2.

IMPORTANT: the current status is highly unstable, it is an alpha version aimed for developers. Users please wait for the first stable release with installers.

Requirements

You do not have to do this if you are using a release since r2 is included in those!

• Radare2: Make sure that, when cloning the project, you use git clone --recurse-submodules or run git submodule update --init to clone the correct radare2 version. Then execute the following command in the radare2 folder:

sys/install.sh

• QtCreator and Qt: Right now cutter uses Qt 5.9.1, you will need the latest QtCreator and Qt added during the installation:
  • Download: Qt Open Source
  • Add Qt 5.9.1: http://doc.qt.io/qtcreator/creator-project-qmake.html

Building from source

First you must clone the repository:

git clone https://github.com/radareorg/cutter
cd cutter

Building radare2

git submodule init radare2 && git submodule update radare2
cd radare2 && ./sys/install.sh
cd ..

Building cutter

Cutter can be build with two methods: The preferred one is with qmake, but you can also compile it with cmake. Choose the one you want to use.

Method 1: Qmake

mkdir build
cd build
qmake ../src
make

Method 2: CMake

cd src
mkdir build
cd build
cmake ..
make

Then run cutter: ./cutter or ./build/cutter

Note: If radare2 is not installed system-wide (./sys/user.sh installation for instance) you might want to use LD_LIBRARY_PATH=$HOME/bin/prefix/radare2/lib ./cutter to run cutter.

Troubleshoting

On Mac, QT5 apps fail to build on QtCreator if you have the libjpeg lib installed with brew. Run this command to workaround the issue:

sudo mv /usr/local/lib/libjpeg.dylib /usr/local/lib/libjpeg.dylib.not-found

If you encounter the Project ERROR: r_core development package not found try this command instead PKG_CONFIG_PATH=$HOME/bin/prefix/radare2/lib/pkgconfig qmake

Platforms

Cutter is developed on OS X, Linux and Windows. The first release for users will include installers for all three platforms.

Documentation

Proper documentation and website will be created before the first release.

Help

Right now the best place to obtain help from cutter developers and community is joining this telegram group:

• https://t.me/r2cutter
• #cutter on irc.freenode.net