English | 中文

🦩 The 鹈鹕 [tíhú] pelican is a bird skilled at catching fish. A trained pelican will deliver all its catch to its owner — and Pelican delivers every alias to you.

Your command-line tool is right in your pelican' pouch — take it out.

A shell alias library that follows the shadcn approach — installed via copy source code, not dependency.

Feel free to customize it — you own the code, just like shadcn.

Install

Adopt a free pelican.

# Use pnpx
pnpx @legend80s/pelican@latest catch # `@latest` is recommended

# Install globally
pnpm install -g @legend80s/pelican
pelican catch

Usage

Go fishing.

# Browse all aliases and find what interests you.
pelican list

# Choose interactively
pelican catch

# Install single alias
pelican catch <fish_name>

# Install multiple alias
pelican catch <fish_name1> <fish_name2> ...

# Show more usage
pelican --help

Installation File Structure

The pelican pouch.

~/.pelican
└── alias-list           # This directory holds all installed aliases.
    ├── index.sh         # Entry point for installed alias functions.
    └── fish_open_npm.sh # Installed `fish_open_npm` alias. Feel free to customize it

It will insert source line below to your ~/.zshrc or ~/.bashrc：

# ~/.zshrc or ~/.bashrc
source ~/.pelican/aliases/index.sh

Uninstall

Release fish back to the wild.

Remove or comment the source line below then open a new terminal tab.

# ~/.zshrc or ~/.bashrc
# source ~/.pelican/aliases/index.sh

Feel free to remove ~/.pelican directory (optional).

Alias List

The fish lake.

Alias	Description	Usage
fish_open_npm	Quickly open a package's npm page.	fish_open_npm [--site=npmx] [pkg_name]
fish_open_repo	Open the current project's repository URL in browser — whether it's GitHub, GitLab or privately deployed.	fish_open_repo
fish_pnpm_init_node_js_pkg	Quickly set up a Node.js ESM CLI App with pnpm.	fish_pnpm_init_node_js_pkg <folder_name>
fish_touchr	Create file at any directory level. For HTML files: automatically inject HTML template or write directly if HTML content detected in clipboard then auto-open in both editor and browser	fish_touchr </path/to/file>
fish_view_pkg_json	Quickly peek into package.json — uses the current project by default, or looks in node_modules/ if you specify a name. You can also pass a key to see just that value	fish_view_pkg_json [pkg_name] [key]

Development

# Run locally
node bin/pocket.js <command>

# Force locale for testing
LANG=en node bin/pocket.js list    # English output
LANG=zh node bin/pocket.js list    # Chinese output

# Run tests
npm test

# Type check
npm run typecheck