Installation
Overview

Installation

Last updated: Mar 11, 2026 14:00 UTC

Quick Start (One-Liner)

On a fresh Ubuntu VPS (24.04 LTS recommended), run:

curl -fsSL https://raw.githubusercontent.com/vitruvyan/vitruvyan-core/main/scripts/install.sh | bash

This single command will:

  1. Install system prerequisites (git, python3, curl)
  2. Clone the repository to /opt/vitruvyan-core
  3. Make the vit command available system-wide
  4. Launch the interactive setup wizard

The wizard then handles everything else: Docker installation, port configuration, environment setup, and infrastructure startup.

!!! tip "Review before running" If you prefer to inspect the script first: bash curl -fsSL https://raw.githubusercontent.com/vitruvyan/vitruvyan-core/main/scripts/install.sh -o install.sh less install.sh bash install.sh

Installation Options

MethodBest forGuide
One-linerFresh VPS, quick deploymentThis page
Manual cloneDevelopers, custom setupsLocal Setup
Docker onlyPre-existing Docker hostDocker Setup
ProductionInstitutional deploymentProduction

Installer Options

The installer script accepts environment variables:

VariableDefaultDescription
INSTALL_DIR/opt/vitruvyan-coreWhere to clone the repository
BRANCHmainGit branch to install
SKIP_SETUP0Set to 1 to skip the setup wizard
REPO_URLgithub.com/vitruvyan/vitruvyan-coreGit repository URL

Example with custom options:

INSTALL_DIR=/home/myuser/vitruvyan BRANCH=develop \
  curl -fsSL https://raw.githubusercontent.com/vitruvyan/vitruvyan-core/main/scripts/install.sh | bash

What Gets Installed

The complete Vitruvyan OS stack consists of:

┌─────────────────────────────────────────────┐
│  Your VPS (Ubuntu)                          │
│                                             │
│  /opt/vitruvyan-core/        ← source code  │
│  /usr/local/bin/vit          ← CLI command  │
│                                             │
│  Docker containers:                         │
│  ├── core_redis      (Cognitive Bus)        │
│  ├── core_postgres   (Archivarium)          │
│  ├── core_qdrant     (Mnemosyne)            │
│  ├── core_graph      (LangGraph API)        │
│  ├── core_nginx      (Reverse Proxy)        │
│  └── ...services     (Sacred Orders)        │
└─────────────────────────────────────────────┘

Post-Installation

After installation, verify with:

vit status          # System overview
vit doctor          # Detailed health check

Next Steps

Pipeline WalkthroughRequirements