dub-cli
A CLI for easily shortening URLs with the Dub.co API.
https://github.com/user-attachments/assets/2ce9fe51-68ab-4e6d-b08d-4da09c17f90e
Available Commands
Command | Description |
---|
dub login [key] | Configure your workspace API key |
dub config | See your configured workspace credentials |
dub domains | Configure your workspace domain |
dub shorten [url] [key] | Create a short link. You can preemptively pass the URL and the generated short link key, or go through the CLI prompts. |
dub links [options] | Search for links in your Dub workspace. Available options include: -s, --search <search> to search for a link by name, or -l, --limit <limit> to limit the number of links returned (default is 10). |
dub help [command] | Display help for a specific command |
Running Locally for Development
- Clone the repository, install dependencies and navigate to the
cli
folder:
cd packages/cli
- Build the package in watch mode:
pnpm dev
- In a separate terminal, navigate to the
cli
folder again and run an available command:
pnpm start [command]
- See all available commands and options:
pnpm start help
Testing Production-like Setup
Warning
If you have previously installed dub-cli
globally, uninstall it first to avoid conflicts
- Clone the repository, install dependencies and navigate to the
cli
folder:
cd packages/cli
- Build the package:
pnpm build
- Link the package globally:
npm link
- Verify the installation:
dub -v
- Run commands:
dub [command]