shadow/README.md
Josh 7000d60fde
Some checks failed
test / test (macos-latest) (push) Has been cancelled
test / test (ubuntu-latest) (push) Has been cancelled
test / test (windows-latest) (push) Has been cancelled
prep for putting repo on GH
2024-12-14 14:01:03 -06:00

843 B

shdw

A CLI tool to manage your shell aliases.

Requirements

  • Rust toolchain
    • The latest is recommended, but any recent version should hopefully work
  • Written with cross-platform compatibility in mind, aiming to support all major operating systems (Linux, macOS, Windows).

Installation

Install directly from the repository:

cargo install --git https://github.com/joshuadavidthomas/shdw

Usage

Adding an alias

Create a new alias by shadowing an existing command:

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

You can specify a custom installation directory:

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

Removing an alias

Remove an existing alias to restore the original command:

shdw remove ls

Listing aliases

View all active aliases:

shdw list