Log in Get started

`dub-cli`

packages/cli/README.md

latest2.9 KB

Original Source

`dub-cli`

A CLI for easily shortening URLs with the Dub API.

https://github.com/user-attachments/assets/2ce9fe51-68ab-4e6d-b08d-4da09c17f90e

Available Commands

Command	Description
`dub login`	Log into the DUB platform
`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:
bash
```
cd packages/cli
```
Build the package in watch mode:
bash
```
pnpm dev
```
In a separate terminal, navigate to the cli folder again and run an available command:
bash
```
pnpm start [command]
```
See all available commands and options:
bash
```
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:
bash
```
cd packages/cli
```
Build the package:
bash
```
pnpm build
```
Link the package globally:
bash
```
 npm link
```
Verify the installation:
bash
```
 dub -v
```
Run commands:
bash
```
dub [command]
```