cutter/README.md
Lovecraft's_Cat 3921ba172e
Added Scoop in the Windows download instructions ()
Since Scoop supports this project, it would be sensible to make it explicit for Windows users that it's an available install option.
2023-01-16 17:33:08 +08:00

3.7 KiB

Cutter logo

Cutter

Cutter is a free and open-source reverse engineering platform powered by rizin. It aims at being an advanced and customizable reverse engineering platform while keeping the user experience in mind. Cutter is created by reverse engineers for reverse engineers.

Cutter CI Build status Total alerts

Screenshot

Learn more at cutter.re.

Getting Cutter

Download

Cutter release binaries for all major platforms (Linux, macOS, Windows) can be downloaded from GitHub Releases.

  • Linux: If your distribution provides it, check for cutter package in your package manager (or cutter-re). If not available there, we have setup repositories in OBS for some common distributions. Look at https://software.opensuse.org/package/cutter-re and follow the instructions there. Otherwise download the .AppImage file from our release, make it executable and run as below or use AppImageLauncher.

    chmod +x Cutter*.AppImage; ./Cutter*.AppImage

  • macOS: Download the .dmg file or use Homebrew Cask:

    brew install --cask cutter

  • Windows: Download the .zip archive, or use either Chocolatey or Scoop:

    choco install cutter

    scoop bucket add extras followed by scoop install cutter

Build from sources

To build Cutter from sources, please check the Building Docs.

Docker image

To deploy cutter using a pre-built Dockerfile, it's possible to use the provided configuration. The corresponding README.md file also contains instructions on how to get started using the docker image with minimal effort.

Documentation

User Guide

Contribution Guidelines

Developers Docs

Plugins

Cutter supports both Python and Native C++ plugins.

Our community has built many plugins and useful scripts for Cutter such as the native integration of Ghidra decompiler or the plugin to visualize DynamoRIO code coverage. You can find a list of cutter plugins linked below. Feel free to extend it with your own plugins and scripts for Cutter.

Official & Community Plugins

Plugins Development Guide

Getting Help

Please use the following channels to ask for help from Cutter developers and community: