Prerequisites

Automated Setup

If you would like to build and develop Artemis yourself you will need a few required applications:

1. Artemis is written in Rust. So you will need to download and install the Rust programming language
2. Git
3. Rust analyzer
4. An IDE or text editor. VSCode or VSCodium are great choices.
5. The command runner Just.

Windows users will need to install Chocolatey. In addition, you will need to install the MSVC version of Rust macOS users will need to install Homebrew

You can use Just to automate most of the setup process.

info

Ubuntu users can run: just setup-ubuntu
Fedora users can run just setup-fedora
Windows users can run just setup-windows (after you have installed Chocolatey and Rust)
macOS users can run just setup-macos (after you have installed Homebrew)

Windows users will need to add extra arguments to the just command:
just --shell pwsh.exe --shell-arg -c

On Windows if you get an error like:
error: Recipe _wasm could not be run because just could not find the shell: program not found

it means you forgot provide: just --shell pwsh.exe --shell-arg -c

If you would like to install the build dependencies manaully, review the Just files .setup folder in the artemis repo for your platform.

Artemis has been developed on:

• macOS 12 (Monterey) and higher
• Windows 10 and higher
• Linux distros such as Ubuntu, Debian, and Fedora

Building

Once you have the prerequisites installed you can build artemis.

1. Clone artemis repo at https://github.com/puffycid/artemis
2. Navigate to the repo
3. Run just cli or just --shell pwsh.exe --shell-arg -c cli for Windows

# Download artemis source code
git clone https://github.com/puffycid/artemis
cd artemis

# Build just the CLI executable
just cli

# Build just the library
just core

Full list of just commands (via just --list)

Available recipes:
    build         # Build the entire artemis project.
    complex       # Review complexity with scc
    default       # Run cargo clippy on artemis project
    filesystem    # Test only the FileSystem functions
    nextest       # Test the entire artemis project using nextest
    runtime       # Test only the JavaScript runtime
    test          # Test the entire artemis project
    timeline      # Test only the timelining functions

    [artifacts]
    ese           # Test only the ESE parsing functions
    eventlogs     # Test only the Eventlog parsing functions
    mft           # Test only the MFT parsing functions
    outlook       # Test only the Outlook parsing functions
    registry      # Test only the Registry parsing functions
    shellitems    # Test only the ShellItems parsing functions
    spotlight     # Test only the Spotlight parsing functions
    wmi           # Test only the WMI parsing functions

    [os]
    linux         # Test all the Linux artifacts
    macos         # Test all the macOS artifacts
    unix          # Test all the Unix artifacts
    windows       # Test all the Windows artifacts

    [setup]
    setup-fedora  # Setup Artemis development environment for Fedora
    setup-macos   # Setup Artemis development environment for macOS
    setup-ubuntu  # Setup Artemis development environment for Ubuntu
    setup-windows # Setup Artemis development environment for Windows

    [workspace]
    cli           # Just build the artemis binary
    core          # Just build core library
    slim          # Just build the artemis binary. But do not enable Yara-X

Building for estoric platforms

Artemis can be compiled for a varierty of platforms using cross. Once you have cross setup you can build artemis for:

• FreeBSD
• Linux MUSL
• Linux RISC-V

If you want to build for Android or NetBSD you have to disable the yara-x dependency

• cross build --release --no-default-features

If you want to build for Windows ARM. You will need a Windows ARM VM and will need to install LLVM. LLVM is required to compile jsonwebtoken which artemis uses to generate JWT when uploading to GCP