Getting started

Installation

Vektor ships as one self-contained executable with no runtime, database, or service stack to set up. Pick the method that fits your environment.

Browse documentation

Getting started

Reference

Operations

Changelog

Prebuilt binaries are published for Linux (x86_64 / arm64) and macOS (arm64 / x86_64) with every release. The install script picks the right one for your machine automatically. Prefer a container? A Docker image is available too.

Install script

The quickest way to get started. This downloads the latest release binary from GitHub Releases and installs it to /usr/local/bin/vektor:

Terminal 
curl -fsSL https://github.com/luckydye/vektor/raw/main/install.sh | sh

The script detects your OS and CPU architecture, then downloads the matching asset:

  • vektor-linux-x64 / vektor-linux-arm64
  • vektor-darwin-arm64 / vektor-darwin-x64

To install somewhere other than /usr/local/bin, set INSTALL_DIR:

Terminal 
curl -fsSL https://github.com/luckydye/vektor/raw/main/install.sh | INSTALL_DIR=~/.local/bin sh

Manual download

If you'd rather not pipe a script to your shell, grab the asset for your platform directly from the GitHub releases page, then make it executable and move it onto your PATH.

Download from GitHub Releases

Docker

Run Vektor as a container. The image bundles the binary and its runtime dependencies, exposes port 8080, and stores data under /app/data:

Terminal 
docker run -d \
  --name vektor \
  -p 8080:8080 \
  -v vektor_data:/app/data \
  ghcr.io/luckydye/vektor

Or with Docker Compose:

compose.yaml 
services:
  app:
    image: ghcr.io/luckydye/vektor:latest
    restart: unless-stopped
    env_file: env
    ports:
      - "8080:8080"
    volumes:
      - vektor_data:/app/data

volumes:
  vektor_data:
    driver: local

Build from source

Vektor is built with Bun and compiles into a single executable. It uses Task to orchestrate the build, including the native Rust addons for image processing, the JS runtime, and local embeddings.

Terminal 
git clone https://github.com/luckydye/vektor.git
cd vektor

# install dependencies and build native addons
task setup

# compile the app + server into a single binary (app/vektor)
task compile

The compiled binary lands at app/vektor.

With Vektor installed, head to the CLI reference to start the server, authenticate, and manage your workspace, or set up the metrics endpoint for monitoring.