Pal is a command line tool to generate an alias to cd
into each of your projects. An alias can also be generated to open the directory with your editor's CLI command, e.g. nvim, code, subl.
brew install jaytyrrell13/tap/pal
Download the latest release archive from the releases page.
To get started, you may execute Pal's install
command. This will ask for the path to your projects, your editor's CLI tool e.g. nvim, code, subl, and your shell e.g. bash, zsh, fish. These settings will be saved in ~/.config/pal/config.json
.
pal install [--path | -p] [--editorCmd | -e]
The make
command will go through each directory of your projects and ask for the alias you want to use. This will generate a ~/.config/pal/aliases
file and update your shell to automatically source the aliases file if it exists. If you use bash or zsh, it will append [ -f "$HOME/.config/pal/aliases" ] && source "$HOME/.config/pal/aliases"
to your ~/.bashrc
or ~/.zshrc
. If you use fish, it will create ~/.config/fish/conf.d/pal.fish
to test if the aliases file exists and if so then source it.
Note: the make
command will prompt you to run the install
command first if the config does not exist yet.
pal make
The add
command can be used if you want an alias for a directory outside your projects. For example, a directory of notes.
Note: the add
command will prompt you to run the make
command if the aliases file does not exist yet.
pal add [--path | -p] [--name | -n]
The list
command will print out all the aliases currently in ~/.config/pal/aliases
.
pal list
The clean
command will delete your ~/.config/pal/aliases
file in your home directory.
pal clean
The refresh
command will delete your ~/.config/pal/aliases
file and then run the make
command.
pal refresh
If you'd like to support the development of pal
, you can buy me a coffee.