README.md
1Capstone Engine
2===============
3
4[](https://travis-ci.org/aquynh/capstone)
5[](https://ci.appveyor.com/project/aquynh/capstone/branch/next)
6[](https://pypi.python.org/pypi/capstone)
7[](https://pepy.tech/project/capstone)
8[](https://app.fuzzit.dev/admin/ANOh0D48gSLBxNZcDQMI/dashboard)<br/>
9
10Capstone is a disassembly framework with the target of becoming the ultimate
11disasm engine for binary analysis and reversing in the security community.
12
13Created by Nguyen Anh Quynh, then developed and maintained by a small community,
14Capstone offers some unparalleled features:
15
16- Support multiple hardware architectures: ARM, ARM64 (ARMv8), BPF, Ethereum VM, Webassembly,
17 M68K, Mips, MOS65XX, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore, RISC-V(rv32G/rv64G)
18 and X86 (including X86_64).
19
20- Having clean/simple/lightweight/intuitive architecture-neutral API.
21
22- Provide details on disassembled instruction (called “decomposer” by others).
23
24- Provide semantics of the disassembled instruction, such as list of implicit
25 registers read & written.
26
27- Implemented in pure C language, with lightweight bindings for D, Clojure, F#,
28 Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python,
29 Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala
30 ready either in main code, or provided externally by the community).
31
32- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
33 Linux, \*BSD, Solaris, etc.
34
35- Thread-safe by design.
36
37- Special support for embedding into firmware or OS kernel.
38
39- High performance & suitable for malware analysis (capable of handling various
40 X86 malware tricks).
41
42- Distributed under the open source BSD license.
43
44Further information is available at http://www.capstone-engine.org
45
46
47Compile
48-------
49
50See COMPILE.TXT file for how to compile and install Capstone.
51
52
53Documentation
54-------------
55
56See docs/README for how to customize & program your own tools with Capstone.
57
58
59Hack
60----
61
62See HACK.TXT file for the structure of the source code.
63
64
65Fuzz
66----
67
68See suite/fuzz/README.md for more information.
69
70
71License
72-------
73
74This project is released under the BSD license. If you redistribute the binary
75or source code of Capstone, please attach file LICENSE.TXT with your products.
76
){kind=link}
){kind=link}