CLI Tool - ClickSpot Docs

CLI Tool

The ClickSpot CLI lets you manage links and migrate from other URL shorteners directly from your terminal.

Installation

macOS and Linux

Run this command in your terminal:

curl -fsSL https://cli.clickspot.io/install.sh | sh

Or with wget:

wget -qO- https://cli.clickspot.io/install.sh | sh

Add to PATH

After installation, add the CLI to your PATH:

export PATH="$PATH:$HOME/.clickspot/bin"

Add this line to your shell profile (~/.bashrc, ~/.zshrc, etc.) to make it permanent.

Verify Installation

clickspot --version

Authentication

Before using the CLI, authenticate with your ClickSpot account using an API key.

Get Your API Key

  1. Go to app.clickspot.io
  2. Navigate to Settings → API Keys
  3. Create a new API key or copy an existing one

Login

clickspot auth login --api-key="YOUR_API_KEY"

Check Status

clickspot auth status

Logout

clickspot auth logout

Available Commands

CommandDescription
clickspot authManage authentication (login, logout, status)
clickspot migrateImport links from other URL shorteners
clickspot upgradeCheck for and install CLI updates

What's Next?