• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1To install Capstone, you should run `pip install capstone`.
2
3If you would like to build Capstone with just the source distribution, without
4pip, just run `python setup.py install` in the folder with setup.py in it.
5
6In order to use this source distribution, you will need an environment that can
7compile C code. On Linux, this is usually easy, but on Windows, this involves
8installing Visual Studio and using the "Developer Command Prompt" to perform the
9installation. See BUILDING.txt for more information.
10
11If you don't want to build your own copy of Capstone, you can use a precompiled
12binary distribution from PyPI. Saying `pip install capstone` should
13automatically obtain an appropriate copy for your system. If it does not, please
14open an issue at https://github.com/aquynh/capstone and tag @rhelmot - they
15will fix this, probably!
16
17--------------------------------------------------------------------------------
18
19Capstone is a disassembly framework with the target of becoming the ultimate
20disasm engine for binary analysis and reversing in the security community.
21
22Created by Nguyen Anh Quynh, then developed and maintained by a small community,
23Capstone offers some unparalleled features:
24
25- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc,
26  SystemZ, XCore and X86 (including X86_64).
27
28- Having clean/simple/lightweight/intuitive architecture-neutral API.
29
30- Provide details on disassembled instruction (called “decomposer” by others).
31
32- Provide semantics of the disassembled instruction, such as list of implicit
33  registers read & written.
34
35- Implemented in pure C language, with lightweight wrappers for C++, C#, Go,
36  Java, NodeJS, Ocaml, Python, Ruby & Vala ready (available in main code,
37  or provided externally by the community).
38
39- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
40  Linux, *BSD, Solaris, etc.
41
42- Thread-safe by design.
43
44- Special support for embedding into firmware or OS kernel.
45
46- High performance & suitable for malware analysis (capable of handling various
47  X86 malware tricks).
48
49- Distributed under the open source BSD license.
50
51Further information is available at http://www.capstone-engine.org
52
53
54[License]
55
56This project is released under the BSD license. If you redistribute the binary
57or source code of Capstone, please attach file LICENSE.TXT with your products.
58