Skip to main content

Interactive setup wizard for Garuda System

Project description

Garuda Setup

Interactive cross-platform setup wizard for Garuda System.

Creates a self-contained install directory with docker-compose.yml, .env, data directories, and launcher scripts — no source checkout needed.

Quick Start

# Install
pip install .

# Run the wizard
garuda-setup

Or run directly without installing:

python -m garuda_setup

What It Does

  1. Asks for an install directory (e.g. ~/garuda)
  2. Creates the directory tree:
    ~/garuda/
    ├── docker-compose.yml   # pulls docker.nxs.solutions/garuda/garuda-system:latest
    ├── .env                 # all configuration
    ├── garuda.sh            # launcher (Linux/macOS)
    ├── garuda.ps1           # launcher (Windows PowerShell)
    ├── garuda.bat            # launcher (Windows CMD)
    ├── README.md
    ├── data/
    │   ├── garuda/          # databases & indexes
    │   ├── qdrant/          # vector search
    │   ├── postgres/        # PostgreSQL
    │   └── ollama/          # LLM models
    ├── home/                # container home directory
    └── watch/               # drop files here for auto-ingestion
    
  3. Optionally pulls the image and starts the container

Configuration Options

The wizard walks through:

  • Install directory — where everything lives
  • API key — auto-generate, provide your own, or skip
  • Port — default 7331
  • Services — IDE, Ollama, GPU passthrough, shell access, VNC desktop
  • External services — connect to existing PostgreSQL, Qdrant, or Ollama
  • AI models — LLM model and embedding model selection
  • Cloud — connect to Garuda Cloud server
  • Credential mounts — GitHub Copilot, GH CLI
  • Extra host mounts — mount host directories for observation

Launcher Commands

After setup, use the generated launcher:

cd ~/garuda
./garuda.sh up        # start
./garuda.sh down      # stop
./garuda.sh logs      # follow logs
./garuda.sh update    # pull latest image & restart
./garuda.sh status    # show container status
./garuda.sh shell     # bash into container
./garuda.sh config    # show current config

Windows: use garuda.bat or garuda.ps1 instead.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

garuda_setup-1.0.0.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

garuda_setup-1.0.0-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file garuda_setup-1.0.0.tar.gz.

File metadata

  • Download URL: garuda_setup-1.0.0.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for garuda_setup-1.0.0.tar.gz
Algorithm Hash digest
SHA256 874a35dd9d193bfb9099a650d1987aa7b2ded87b7f61b64d886d71299e5ceaca
MD5 6d91bd1cd722d04f00d916d6424759fe
BLAKE2b-256 65717e98e8e5ff8ec7111956bab582e78816bb114192f6f1bb41a8b1c041f474

See more details on using hashes here.

File details

Details for the file garuda_setup-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: garuda_setup-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for garuda_setup-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94b282c62b78fb2ffc2c0a78245b99e4ef0a4c279dffe7c8b07411d29b9694fa
MD5 76507d318467a8dd42f0a14039d8fe76
BLAKE2b-256 6749cd101ba57f1b1cd2e29034c1c6063ce0cb026b1c112ce2709445d30a2d62

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page