Getting Started

amoxide (am) is a shell alias manager that brings direnv-like functionality to aliases. Instead of managing shell aliases in static dotfiles, define them per project, per toolchain, or globally — and the right ones load automatically.

Quick Start

1. Install amoxide:

Homebrew

brew install sassman/tap/amoxide sassman/tap/amoxide-tui

Shell Script

curl -fsSL https://github.com/sassman/amoxide-rs/releases/latest/download/amoxide-installer.sh | sh
curl -fsSL https://github.com/sassman/amoxide-rs/releases/latest/download/amoxide-tui-installer.sh | sh

PowerShell

powershell -ExecutionPolicy Bypass -c "irm https://github.com/sassman/amoxide-rs/releases/latest/download/amoxide-installer.ps1 | iex"
powershell -ExecutionPolicy Bypass -c "irm https://github.com/sassman/amoxide-rs/releases/latest/download/amoxide-tui-installer.ps1 | iex"

Cargo (pre-built)

cargo binstall amoxide amoxide-tui

Cargo

cargo install amoxide amoxide-tui

2. Set up your shell:

am setup fish          # or: zsh, powershell

This detects your profile file, shows exactly what it will add, and asks for confirmation. See Shell Setup for the manual approach.

3. Add your first alias:

am add gs git status

That's it — gs is now available on your active profile, no restart needed. Use -g for a global alias (always active) or -l for a project-specific one:

am add -l t cargo test

This writes to a .aliases file in the current directory — loaded automatically when you cd in, unloaded when you leave. See Usage for how global, profile, and project aliases work together.

4. See your aliases:

am ls
# or short: am l

What's Next?

• Installation — all installation methods in detail
• Shell Setup — how the shell integration works
• Profiles — organize aliases into reusable groups
• Project Aliases — auto-loading .aliases files