Skip to content

Installation

Package Managers

sh
brew install sassman/tap/amoxide sassman/tap/amoxide-tui
sh
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"
sh
cargo binstall amoxide amoxide-tui
sh
cargo install amoxide amoxide-tui

The crate is called amoxide, but the binary it installs is simply am.

TIP

The TUI companion (am-tui) is a separate install. It's optional but recommended for visual alias management.

Shell Support

ShellStatus
FishFully supported and tested
PowerShellSupported and tested (5.1 + 7)
ZshSupported, not yet tested
Bash, NushellNot yet implemented

Subcommands

CommandDescription
am addAdd a new alias (global, profile, or local)
am removeRemove an alias
am profileManage profiles (add, use, remove, list)
am lsList all profiles and project aliases
am initPrint shell init code
am statusCheck if the shell is set up correctly
am setupGuided shell setup
am tuiInteractive TUI for managing aliases and profiles (separate install)
am hookCalled by the cd hook (internal)

TIP

All verbs have short forms: am a for add, am r for remove, am p for profile, am l for ls.

Installing am-tui

The am tui command requires the TUI companion (amoxide-tui) to be installed separately. If it's not installed, am tui will show install instructions.

sh
brew install sassman/tap/amoxide-tui
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-tui-installer.ps1 | iex"
sh
cargo binstall amoxide-tui
sh
cargo install amoxide-tui

Released under the GPLv3 License. Privacy Policy