Installation

Installing Vandor CLI

The Vandor CLI is the only tool you need. It handles project scaffolding, code generation, package management, and running your application.

One-Line Install (Recommended)

The fastest way to get started:

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

This script will:

1. Detect your operating system and architecture
2. Download the latest Vandor CLI binary
3. Install it to /usr/local/bin (or ~/.local/bin if you do not have sudo)
4. Make it executable
5. Offer to configure your PATH if needed

GitHub Releases

You can also download the binary directly from the GitHub Releases page. Download the archive for your platform, extract it, and move the vandor binary somewhere in your PATH:

# Example for Linux amd64
tar -xzf vandor_linux_amd64.tar.gz
sudo mv vandor /usr/local/bin/

Go Install

If you prefer installing through Go:

go install github.com/alfariiizi/vandor@latest

Make sure $GOPATH/bin (typically ~/go/bin) is in your PATH.

Custom Install Directory

To install to a specific location:

INSTALL_DIR=/custom/path curl -fsSL https://raw.githubusercontent.com/alfariiizi/vandor/main/scripts/install.sh | bash

Verify Installation

After installing, confirm everything is working:

vandor version

You should see output showing the Vandor version, Go version, and build date.

Supported Platforms

Vandor runs on:

• Linux -- All major distributions (Ubuntu, Fedora, Arch, Debian, etc.)
• macOS -- Intel and Apple Silicon
• WSL -- Windows Subsystem for Linux (recommended for Windows users)
• Windows -- Native Windows support is available, but WSL provides the best experience

Platform-Specific Notes

Linux: Make sure you have git installed. Most distributions include it by default.

# Ubuntu/Debian
sudo apt install git

# Fedora
sudo dnf install git

# Arch
sudo pacman -S git

macOS: Install Xcode Command Line Tools if you have not already:

xcode-select --install

Windows (WSL recommended): Install WSL2 and use Ubuntu, then follow the Linux instructions inside WSL:

wsl --install

If you prefer native Windows, download the binary from GitHub Releases and add its directory to your system PATH.

Shell Completion

Setting up shell completion is highly recommended. It gives you tab-completion for all commands, subcommands, and flags.

Zsh (with Oh-My-Zsh):

vandor completion zsh > ~/.oh-my-zsh/completions/_vandor
exec zsh

Zsh (without Oh-My-Zsh):

mkdir -p ~/.zsh/completions
vandor completion zsh > ~/.zsh/completions/_vandor
# Add to ~/.zshrc: fpath=(~/.zsh/completions $fpath) && autoload -Uz compinit && compinit
exec zsh

Bash:

mkdir -p ~/.local/share/bash-completion/completions
vandor completion bash > ~/.local/share/bash-completion/completions/vandor
exec bash

Fish:

vandor completion fish > ~/.config/fish/completions/vandor.fish
exec fish

PowerShell:

Add-Content -Path $PROFILE -Value 'vandor completion powershell | Out-String | Invoke-Expression'
. $PROFILE

After setup, test it:

vandor <TAB>          # Shows all top-level commands
vandor add <TAB>      # Shows: context, domain, usecase, service, valueobject
vandor vpkg <TAB>     # Shows VPKG subcommands

Updating Vandor

To update to the latest version:

vandor upgrade

Or simply re-run the install script -- it will replace the existing binary with the latest version.

Uninstalling

To remove Vandor:

vandor install uninstall

Or remove the binary manually:

rm $(which vandor)

Troubleshooting

"command not found" After Installation

The install directory might not be in your PATH. Check where Vandor was installed:

ls ~/.local/bin/vandor
ls /usr/local/bin/vandor

Then add the correct directory to your PATH. For example, for ~/.local/bin:

# Bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc

# Zsh
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc

# Fish
fish_add_path ~/.local/bin

Permission Denied During Installation

Install to your user directory instead:

INSTALL_DIR=$HOME/.local/bin curl -fsSL https://raw.githubusercontent.com/alfariiizi/vandor/main/scripts/install.sh | bash

Go Version Too Old

Vandor requires Go 1.24 or higher. Check your version and update if needed:

go version

# Update via your package manager, or download from https://go.dev/dl/

Next Steps

Now that Vandor is installed, jump into creating your first project:

• Quick Start -- Create and run a project in 5 minutes
• Your First Project -- Build a complete API step by step