Skip to content

Getting Started

Welcome to PentLog! This guide will help you get up and running in under 5 minutes.

What You'll Learn

  • Quick Start

    Get PentLog installed and running with your first engagement in just a few commands.

    Quick Start

  • Installation

    Detailed installation instructions for all platforms and dependency setup.

    Installation

  • Core Concepts

    Understand PentLog's evidence-first design, context modes, and session organization.

    Core Concepts

System Requirements

Requirement Minimum Recommended
OS macOS 10.15+ / Linux kernel 4.0+ Latest macOS / Ubuntu LTS
Go 1.24.0+ 1.24.0+
Disk Space 100 MB 1 GB+
Memory 512 MB RAM 2 GB+ RAM
Shell Bash / Zsh Zsh with plugins

Quick Install

curl -sSf https://raw.githubusercontent.com/aancw/pentlog/main/install.sh | sh

This installs the latest release to ~/.local/bin/pentlog.

git clone https://github.com/aancw/pentlog.git
cd pentlog
go build -o pentlog main.go
sudo mv pentlog /usr/local/bin/

Verify Installation

# Check version
pentlog version

# Verify dependencies
pentlog setup

Next Steps

  1. Quick Start — Run through a complete example
  2. Installation — Detailed platform-specific instructions
  3. Core Concepts — Understand how PentLog works