Skip to main content

Getting Started

Get up and running with Eko in minutes.

Prerequisites​

  • Go: Version 1.21+ (if building from source)
  • Linux Keychain Packages (Linux only): libsecret-1-dev and pkg-config (required for secure credential keyring integration)

Installation​

1. Homebrew (macOS)​

brew tap kavix/tap
brew install eko

2. Build From Source​

git clone https://github.com/kavix/eko.git
cd eko
go build -o eko .

Quick Start Guide​

1. Initialize Eko​

eko init

This creates the hidden SQLite database and storage directory inside .eko/.

2. Save a Snapshot​

eko save

# Auto-generate an AI summary of changes when saving:
eko save --ai

3. Generate AI Summaries​

eko summary

4. View Snapshot History​

eko history

5. Compare Snapshots​

# View list of modified files between two snapshots
eko diff <snapshot-id-1> <snapshot-id-2>

# View full file code modifications (verbose mode)
eko diff <snapshot-id-1> <snapshot-id-2> -v

6. Restore a Snapshot State​

eko restore <snapshot-id>