Rename root command to `vek` with `vektor` alias #21

New issue

Open

opened 2026-03-16 22:37:14 +00:00 by austin · 0 comments

austin commented

2026-03-16 22:37:14 +00:00

Owner

The primary CLI binary should be vek for quick, ergonomic usage. A vektor alias should also work so users can use the full name if they prefer.

What needs to happen

Rename the binary output from vektor to vek in the build configuration (go build -o vek ./cmd/vektor)
Rename the cmd/vektor directory to cmd/vek to match the binary name
Install a vektor symlink or hard link alongside vek (handle in Makefile / install instructions)
Update the Cobra root command's Use field to vek and add vektor as an alias
Update any references in help text, config paths, and documentation to reflect vek as the primary name
Config directory should stay ~/.config/vektor/ — the project name doesn't change, just the shorthand binary name

Key files

cmd/vek/main.go — renamed entry point
internal/cli/root.go — root Cobra command (Use: "vek")
Makefile — build target and symlink install step

The primary CLI binary should be `vek` for quick, ergonomic usage. A `vektor` alias should also work so users can use the full name if they prefer. ## What needs to happen 1. Rename the binary output from `vektor` to `vek` in the build configuration (`go build -o vek ./cmd/vektor`) 2. Rename the `cmd/vektor` directory to `cmd/vek` to match the binary name 3. Install a `vektor` symlink or hard link alongside `vek` (handle in `Makefile` / install instructions) 4. Update the Cobra root command's `Use` field to `vek` and add `vektor` as an alias 5. Update any references in help text, config paths, and documentation to reflect `vek` as the primary name 6. Config directory should stay `~/.config/vektor/` — the project name doesn't change, just the shorthand binary name ## Key files - `cmd/vek/main.go` — renamed entry point - `internal/cli/root.go` — root Cobra command (`Use: "vek"`) - `Makefile` — build target and symlink install step