zvm: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

ZVM (Zig Version Manager) is a CLI tool written in Go for installing and managing multiple Zig compiler versions. It also supports installing ZLS (Zig Language Server). Built with urfave/cli/v3.

Build & Test Commands

go build -v .                    # Build the binary
go test -v ./...                 # Run all tests
go test -v ./cli/ -run TestName  # Run a single test
go vet ./...                     # Static analysis
govulncheck ./...                 # Known vulnerabilities in code and dependencies
go fmt ./...                     # Format code

Run tests, vet, and govulncheck during reviews and implementation work. If govulncheck is missing, install it with go install golang.org/x/vuln/cmd/govulncheck@latest.

Build without self-upgrade capability (for package manager distributions):

go build -tags noAutoUpgrades .

Package managers should also override the upgrade hint shown by zvm upgrade. The default in main.go is generic; inject a specific one (note the quotes — the value contains spaces and Go re-splits the -ldflags string):

go build -tags noAutoUpgrades \
  -ldflags "-s -w -X 'main.BuildUpgradeMessage=Use \`brew upgrade zvm\` to update ZVM.'" .

Deno tasks (see deno.jsonc):

deno task build          # cross-platform release artifacts into build/
deno task release        # package tests, build tests, version check, then build
deno task star-history   # regenerate the README star chart (token or gh auth login)

Architecture

Entry point: main.go — defines the CLI app with urfave/cli/v3. A Before hook initializes a global ZVM instance that all command handlers share.

Core type: cli.ZVM (in cli/config.go) holds baseDir (default ~/.zvm) and Settings. Initialized via Initialize() which creates the directory structure and loads ~/.zvm/settings.json.