Installation

Installation

If you just want to use the tool, you can install CME in a few different ways according to what you find easiest.

• Docker
• Official Binary releases
• Python Package

If you intend on making code changes and/or submitting a Pull Request, see Installing from source

Docker

docker pull byt3bl33d3r/crackmapexec

Yup. Easy peasy.

Binaries

• You need a compatible version of Python 3 installed in order to run the binaries

For the latest stable binary releases, go here

If you want the latest bleeding-edge binaries, you need to be logged into Github in order to see them and download them: go to the actions tab (at the top of the repo), click on the latest build and download the appropriate binary according to your OS.

Python Package

It's highly recommended you use Pipx to install CME as it isolates all its dependencies for you and eliminates 90% of all problems you'll usually encounter while installing it this way.

#~ python3 -m pip install pipx
#~ pipx ensurepath
#~ pipx install crackmapexec

Installing from Source

You should only install from source if you intend on making changes to the code and/or submitting a PR

Please note the --recursive flag passed to the git clone command. This flag will make git automatically download all of the sub-modules CME depends on. Without this flag installation will fail and heads might explode.

You're going to need to install Poetry which is what CME uses to manage dependencies.

#~ apt-get install -y libssl-dev libffi-dev python-dev build-essential
#~ git clone --recursive https://github.com/byt3bl33d3r/CrackMapExec
#~ cd CrackMapExec
#~ poetry install