Command reference

Small verbs, predictable output.

Aliaz keeps the open-source command surface compact: alias CRUD, collections, shell output, migration, JSON portability, optional sync, logout, and health checks.

Local aliases

Add, list, edit, and remove aliases.

local store
$ aliaz add gs "git status"
Added gs to shared

$ aliaz collection add mac
Created collection mac

$ aliaz add pbcopy-path "pwd | pbcopy" --collection mac
Added pbcopy-path to mac

$ aliaz collection activate mac
Activated mac

$ aliaz list --all
gs	git status	shared	active
pbcopy-path	pwd | pbcopy	mac	active

$ aliaz select git

$ aliaz edit gs "git status --short"
Updated gs in shared

$ aliaz rm gs
Deleted gs from shared
Shell output

Print definitions or write integration files.

Supported shell values are zsh, bash, and fish. generate prints to stdout; init writes managed files.

Generate

$ aliaz generate zsh
alias gs='git status'

Initialize

$ aliaz init fish
Wrote ~/.config/fish/conf.d/aliaz.fish

For zsh and bash, init also updates the startup file once. The managed integration refreshes aliases after successful add, edit, rm, collection, migrate, import, and sync commands.

Portability

Migrate, export, and import.

Use migration for zsh-style alias files, and JSON import/export when you want a portable file.

portable aliases
$ aliaz migrate --from ~/.zshrc
$ aliaz export --output aliases.json
$ aliaz import aliases.json
Reference

Current command surface.

Command Purpose Notes
add <name> <command> [--collection <collection>] Create or update an alias. Names allow ASCII letters, numbers, _, -, and .. Defaults to shared.
list [--all] [--collection <collection>] Print effective aliases. Default output is name and command. --all includes collection and active state.
select [search text] Search aliases and run one. Opens an interactive list of effective aliases. Press Enter to run the selected command.
edit <name> <command> [--collection <collection>] Update an alias command. Pass --collection when a name exists in multiple collections.
rm <name> [--collection <collection>] Delete an alias. delete is accepted as an alias.
collection add <name> Create a synced collection. Collections are inactive until activated locally.
collection list List collections. Shows active or inactive state for this computer.
collection activate <name>... Activate collections on this computer. Later active collections override earlier ones.
collection deactivate <name> Deactivate a collection locally. shared cannot be deactivated.
collection move <alias> --from <collection> --to <collection> Move an alias between collections. Preserves the alias record and marks it for sync.
migrate --from <path> Import zsh-style aliases. Defaults to ~/.zshrc.
generate <shell> Print shell aliases. Does not write files.
init <shell> Write managed shell files. zsh and bash update the startup file once.
export --output <path> Export aliases as JSON. Prints JSON when no output path is provided.
import <path> Import exported JSON. Version 2 exports preserve collections.
update Install the latest release. Replaces the installed binary in place.
uninstall Remove shell integration and the binary. Keeps aliases and sync data intact.
register --username <name> Create a sync account. Prompts for a password and prints a recovery phrase.
login --username <name> Configure sync on another machine. Prompts for the password and recovery phrase.
sync Pull and push encrypted alias records. Requires register or login first.
logout Remove local sync config and recovery material. Does not delete server-side account data.
status Report alias and sync state. Shows pending sync records.
doctor Check local setup. Checks database, integration files, sync config, and secrets. Use --fix to refresh shell integration.