shadow/README.md
2024-12-14 01:13:44 -06:00

849 B

shadow

A CLI tool to manage your shell aliases through symlinks.

Requirements

  • Rust toolchain
    • The latest is recommended, but any recent version should hopefully work
  • It's to be platform-agnostic and should work on all major operating systems (Linux, macOS, Windows).

Installation

Install directly from the repository:

cargo install --git https://git.joshthomas.dev/josh/shadow

Usage

Adding a shadow

Create a new alias by shadowing an existing command:

shadow add ls exa  # 'ls' will now execute 'exa'

You can specify a custom installation directory:

shadow add --bin-path ~/.local/bin ls exa

Removing a shadow

Remove an existing shadow to restore the original command:

shadow remove ls

Listing shadows

View all active shadows:

shadow list