https://github.com/jaytyrrell13/pal
Pal is a command line tool to generate an alias to `cd` into each of your projects.
https://github.com/jaytyrrell13/pal
cli-app cli-application command-line commandline go golang
Last synced: about 2 months ago
JSON representation
Pal is a command line tool to generate an alias to `cd` into each of your projects.
- Host: GitHub
- URL: https://github.com/jaytyrrell13/pal
- Owner: jaytyrrell13
- License: mit
- Created: 2024-03-12T00:08:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T02:18:41.000Z (almost 2 years ago)
- Last Synced: 2024-05-28T12:07:17.457Z (almost 2 years ago)
- Topics: cli-app, cli-application, command-line, commandline, go, golang
- Language: Go
- Homepage:
- Size: 68.4 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pal
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.
## Installation
### Homebrew
```shell
brew install jaytyrrell13/tap/pal
```
### Manual Installation
Download the latest release archive from the [releases](https://github.com/jaytyrrell13/pal/releases) page.
## Usage
To get started, you may execute Pal's `install` command to create the config file in `~/.config/pal/config.json`.
```shell
pal install
```
The `create` command will ask, "What type of alias would you like to create?," with three options, "Parent", "Directory", and "Action". Use "Parent" to create aliases for the child directories under a specific directory. Use "Directory" to create an alias for a single directory. Use "Action" to create an alias for a command or script (ex. alias "ll" for "ls -lah").
```shell
pal create
```
The `update` command allows updating the name or command for one or more aliases.
```shell
pal update
```
The `remove` command allows removing one or more aliases.
```shell
pal remove
```
The `list` command will print out all the aliases currently in `~/.config/pal/aliases`.
```shell
pal list
```
The `config` command allows listing or updating config values.
```shell
pal config list
```
```shell
pal config update
```
## Support
If you'd like to support the development of `pal`, you can [buy me a coffee](https://www.buymeacoffee.com/jaytyrrell).