Command Line Interface (CLI)

Programmatically manage your CodeQR resources directly from your terminal.

Install

npm

npm i -g codeqr-cli@latest

npm i -g codeqr-cli@latest

yarn global add codeqr-cli@latest

pnpm i -g codeqr-cli@latest

To update an existing installation, run the same command.

Version

Check your installed version of CodeQR CLI:

codeqr --version
# => 0.0.12

Commands

Below is a list of available commands in the CodeQR CLI:

codeqr login

Log into the CodeQR platform:

codeqr login

codeqr config

View your workspace credentials:

codeqr config

codeqr domains

Configure a domain for URL shortening:

codeqr domains

codeqr shorten

Create a short link:

codeqr shorten

You can preemptively pass the URL and the generated short link key, or go through the CLI prompts.

codeqr shorten [url] [key]

codeqr links

Search for links in your CodeQR workspace:

codeqr links

Here are the available options:

Option	Description
-s, --search <search>	Search by name
-l, --limit <limit>	Limit the number of results (default is 10)

codeqr links [options]

codeqr help

Get help for a specific command:

codeqr help [command]

Demo

Watch the CodeQR CLI in action: