velocity-installer

command module
v0.21.72 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2026 License: MIT Imports: 10 Imported by: 0

README

Velocity Installer

The official installer CLI for Velocity Go web framework.

Installation

Homebrew (macOS)
brew tap velocitykode/tap
brew install velocity

Commands

velocity new <name>     # Create a new Velocity project
velocity init           # Initialize Velocity in existing project
velocity config         # Manage CLI configuration
velocity self-update    # Update to latest version

Quick Start

# Install
brew install velocitykode/tap/velocity

# Create a new project
velocity new myapp

# Project is ready with dev servers running
# Go server: http://localhost:4000
# Vite: http://localhost:5173

Architecture

Velocity uses two CLI tools:

Tool Install Purpose
velocity Homebrew Create projects, manage config
vel Built from source Dev server, migrations, generators

When you run velocity new, it:

  1. Scaffolds a new project
  2. Installs dependencies
  3. Runs migrations
  4. Builds the ./vel binary
  5. Starts development servers

Configuration

Set defaults for new projects:

velocity config set default.database postgres
velocity config set default.cache redis
velocity config set default.auth true

Configuration stored in ~/.vel/config.yaml.

Documentation

Full documentation at velocity.velocitykode.com/docs

License

MIT License - See LICENSE for details.

Documentation

Overview

Velocity installer - creates and manages Velocity projects

Directories

Path Synopsis
internal
tui
Package tui drives the interactive "velocity new" wizard using prism prompts.
Package tui drives the interactive "velocity new" wizard using prism prompts.
ui
Package ui holds installer-specific output helpers that have no SDK equivalent.
Package ui holds installer-specific output helpers that have no SDK equivalent.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL