Skip to main content

Installation

Currently only Windows, macOS, and Linux binaries from GitHub Releases are provided. Currently these binaries are unsigned.

Grab the latest stable release here

Nightly releases can be downloaded here

Supported Systems​

Currently artemis has been tested on the following types of systems:

  • Windows 8.1 and higher. Arch: 64-bit
  • macOS Catalina and higher. Arch: 64-bit and ARM
  • Ubuntu, Fedora, Arch Linux. Arch: 64-bit and ARM

If you would like support for another OS or architecture please open an issue.

GitHub Releases​

Once downloaded for you platform from GitHub, extract the binary from the archive and you should be able to start collecting forensic data!

Build from Source​

You may also build artemis from source. In order build artemis you will need to install the Rust programming langague. In addition, you will need to install cmake in order to compile the zlib dependency

  • Instructions to install Rust can be found on the Rust Homepage.
  • Cmake can be install via Homebrew, Chocolatey, or Linux package manager

Once Rust and cmake are installed you can download the source code for artemis using git:

git clone https://github.com/puffycid/artemis

Navigate to your downloaded repo and the cli directory and run:

// from the cli/ directory in the artemis repo
cargo build

By default cargo builds a debug version of the binary. If you want to build the release version (recommended) of the binary run:

cargo build --release

The release version will be much faster and smaller than the debug version. The compiled binary will be located at:

  • <path to artemis repo>\target\debug\artemis for the debug version
  • <path to artemis repo>\target\release\artemis for the release version
info

If you get an error like below:

error: #[derive(RustEmbed)] folder '/Users/android/Projects/artemis/server/../target/dist/web' does not exist. cwd: '/Users/android/Projects/artemis'
 --> server/src/frontend/webui.rs:7:1
  |
7 | / #[folder = "../target/dist/web"]
8 | | struct Frontend;
  | |________________^

It means you are trying to compile the entire artemis project, instead of just the CLI. You will need to navigate to the cli/ directory to just build the artemis cli binary

Alternatively, you may also install the command runner Just and run:

just cli
or for Windows
just --shell pwsh.exe --shell-arg -c cli

to compile the cli

Please see the Contributing documentation if you would like to compile the entire project including optional experimental components