Command Reference #
Complete guide to all Velocity commands with examples and options.
Package Management #
install #
Install packages locally or globally.
# Install package locally (adds to velo.json)
velo install imagemagick
# Install package globally
velo install wget --global
# Install specific version
velo install wget --version 1.21.3
# Install all dependencies from velo.json
velo install
# Install with exact versions from velo.lock (CI mode)
velo install --frozen
# Verify before installing
velo install --check
Options:
--global
- Install globally instead of locally--version <version>
- Install specific version if available--frozen
- Install exact versions from lock file--check
- Verify packages before installing
uninstall #
Remove installed packages.
# Remove package (all versions)
velo uninstall wget
# Remove specific version only
velo uninstall wget --version 1.21.3
# Remove from global installation
velo uninstall wget --global
Options:
--global
- Remove from global installation--version <version>
- Remove specific version only
list #
List installed packages and versions.
# List all installed packages
velo list
# Show all versions of each package
velo list --versions
# List global packages only
velo list --global
# List local packages only
velo list --local
Options:
--versions
- Show all installed versions--global
- Show only global packages--local
- Show only local packages
switch #
Change the default version of a package.
# Switch default version of wget
velo switch wget 1.21.3
# Switch global package version
velo switch wget 1.21.3 --global
Options:
--global
- Switch global package version
info #
Show detailed information about packages.
# Show package information
velo info wget
# Show information for specific version
velo info wget --version 1.21.3
Options:
--version <version>
- Show info for specific version
search #
Search for packages in repositories.
# Search for packages containing "http"
velo search http
# Search with wildcards
velo search "web*"
# Search in specific tap
velo search nginx --tap homebrew/nginx
Options:
--tap <tap>
- Search in specific repository only
Project Management #
init #
Initialize a new project with velo.json manifest.
# Create new project
velo init
# Initialize with specific name
velo init --name "my-project"
# Initialize with dependencies
velo init --with imagemagick,ffmpeg
Options:
--name <name>
- Set project name--with <packages>
- Add initial dependencies
exec #
Execute commands using local packages.
# Run command with local packages in PATH
velo exec convert image.jpg output.png
# Run complex commands
velo exec bash -c "convert *.jpg -resize 50% smaller/"
# Run interactive shell with local packages
velo exec bash
which #
Show which binary will be used for a command.
# Show resolution order
velo which convert
# Show all available versions
velo which convert --all
# Show global version only
velo which convert --global
Options:
--all
- Show all available versions--global
- Show only global version
verify #
Verify that installed packages match velo.lock.
# Verify all packages
velo verify
# Verify and show differences
velo verify --verbose
# Verify specific package
velo verify imagemagick
Options:
--verbose
- Show detailed differences<package>
- Verify specific package only
Repository Management #
tap #
Manage package repositories.
# List all taps
velo tap list
# List global taps only
velo tap list --global
# Add a new tap
velo tap add user/homebrew-tools
# Add tap with full URL
velo tap add https://github.com/user/homebrew-tools.git
# Remove a tap
velo tap remove user/homebrew-tools
# Update all taps
velo tap update
# Update specific tap
velo tap update homebrew/core
# Force global tap operations (skip velo.json)
velo tap add user/tools --global
Options:
--global
- Operate on global taps onlylist
- Show installed tapsadd <tap>
- Add new tapremove <tap>
- Remove tapupdate [tap]
- Update taps
update #
Update package repositories.
# Update all repositories
velo update
# Update and show changes
velo update --verbose
# Update specific tap only
velo update homebrew/core
Options:
--verbose
- Show detailed update information<tap>
- Update specific tap only
System Management #
doctor #
Check system health and configuration.
# Run all health checks
velo doctor
# Show detailed system information
velo doctor --verbose
# Check specific component
velo doctor --check taps
Options:
--verbose
- Show detailed system information--check <component>
- Check specific component (taps, packages, permissions)
repair #
Repair existing package installations by fixing library path issues.
# Check all packages for repair issues (dry run)
velo repair --dry-run
# Repair all packages with issues
velo repair
# Repair specific package
velo repair ffmpeg
# Force repair even if no issues detected
velo repair --force
Options:
--dry-run
- Show what would be repaired without making changes--force
- Force repair even if no issues are detected<package>
- Repair specific package only
When to use repair:
- After upgrading from Homebrew to Velo
- When packages fail with dyld symbol loading errors
- If binary or library dependencies are broken
- When
@@HOMEBREW_PREFIX@@
placeholders weren’t replaced during installation
clean #
Clean packages, cache, or temporary files.
# Clean download cache
velo clean --cache
# Clean all packages (like Homebrew reset)
velo clean --packages
# Clean everything (packages + cache)
velo clean --all
# Clean specific package
velo clean wget
# Dry run (show what would be cleaned)
velo clean --cache --dry-run
Options:
--cache
- Clean download cache--packages
- Remove all packages--all
- Clean everything--dry-run
- Show what would be cleaned<package>
- Clean specific package
Self Management #
install-self #
Install Velocity to system.
# Install velo to ~/.velo/bin and add to PATH
velo install-self
# Install as symlink for development
velo install-self --symlink
# Force reinstall even if already installed
velo install-self --force
Options:
--symlink
- Create symlink for development--force
- Force reinstall
uninstall-self #
Remove Velocity from system.
# Uninstall velo binary only (keep packages)
velo uninstall-self --binary-only
# Uninstall everything (interactive confirmation)
velo uninstall-self
# Force uninstall without confirmation
velo uninstall-self --force
Options:
--binary-only
- Remove binary only, keep packages--force
- Skip confirmation prompts
update-self #
Update Velocity to latest version.
# Check for updates without installing
velo update-self --check
# Update to latest stable release
velo update-self
# Update to pre-release version
velo update-self --pre-release
# Force update even if on latest version
velo update-self --force
# Update without creating backup
velo update-self --skip-backup
Options:
--check
- Check for updates only--pre-release
- Include beta versions--force
- Force update--skip-backup
- Skip backup creation
Multi-Version Support #
Velocity supports installing and managing multiple versions of packages:
Version-Specific Installation #
# Install latest version
velo install wget
# Install specific version (when available)
velo install wget --version 1.21.3
# List all available versions
velo info wget
Binary Access #
- Default symlinks:
~/.velo/bin/wget
(points to default version) - Versioned symlinks:
~/.velo/bin/wget@1.21.3
(specific version access) - Library compatibility: Each version maintains independent library paths
Managing Multiple Versions #
# List all installed versions
velo list --versions
# Switch default version
velo switch wget 1.21.3
# Remove specific version only
velo uninstall wget --version 1.21.3
# Remove all versions
velo uninstall wget
Global Options #
These options work with most commands:
--help, -h
- Show help information--verbose, -v
- Enable verbose output--quiet, -q
- Suppress non-essential output--dry-run
- Show what would be done without executing--global
- Operate on global packages/taps--local
- Operate on local packages/taps only
Examples #
Common Workflows #
Set up a new project:
cd my-project
velo init
velo install imagemagick ffmpeg shellcheck
velo exec convert --version # Uses local imagemagick
Install development tools globally:
velo install wget curl jq --global
velo install node@18 --global # Specific version
Update everything:
velo update # Update repositories
velo update-self # Update Velocity itself
Clean up system:
velo clean --cache # Free up disk space
velo doctor # Check system health
Fix broken packages:
velo repair --dry-run # Check what needs repair
velo repair # Fix all issues
velo doctor # Verify system health