CLI Command Line Tool

Shortlinker provides an intuitive and easy-to-use command line tool for managing short links.

Tool Features

• 🎨 Colored Output - Clear visual feedback
• 🔄 Real-time Sync - Commands take effect immediately
• ⚡ Fast Response - Supports SQLite, PostgreSQL, MySQL, MariaDB storage backends
• 🛡️ Error Handling - Detailed error messages and suggestions
• 📦 Import/Export - CSV format backup and migration support (JSON is legacy/deprecated)

Basic Syntax

./shortlinker                         # start HTTP server (default)
./shortlinker <command> [args] [opts] # run CLI command

Command Overview

Note: start/stop/restart are not built-in subcommands. To start the service, run ./shortlinker without a subcommand. Stopping/restarting is typically handled by systemd/Docker or OS signals (see deployment/ops docs).

Command	Function	Example
help	Show help	./shortlinker help
add	Add short link	./shortlinker add github https://github.com
remove	Delete short link	./shortlinker remove github
update	Update short link	./shortlinker update github https://new-url.com
list	List all links	./shortlinker list
export	Export data	./shortlinker export backup.csv
import	Import data	./shortlinker import backup.csv --force
generate-config	Generate config template	./shortlinker generate-config
reset-password	Reset admin password	./shortlinker reset-password
config	Runtime config management (DB)	./shortlinker config list
tui	Launch TUI interface (requires build feature)	./shortlinker tui

Quick Examples

Basic Operations

# Add short link
./shortlinker add docs https://docs.example.com

# View all links
./shortlinker list

# Delete link
./shortlinker remove docs

Data Management

# Export data
./shortlinker export backup.csv

# Import data
./shortlinker import backup.csv --force

Advanced Features

# Random short code
./shortlinker add https://example.com
# Output: ✓ Added short link: aB3dF1 -> https://example.com

# Set expiration time
./shortlinker add sale https://shop.com/sale --expire 2024-12-25T00:00:00Z

# Force overwrite
./shortlinker add docs https://new-docs.com --force

# Launch TUI interface
./shortlinker tui

Output Description

Success Status

• ✅ Green text indicates successful operation
• 🔵 Blue text shows informational messages

Error Status

• ❌ Red text shows error messages
• 💡 Provides solution suggestions

Example Output

$ ./shortlinker add github https://github.com
✓ Added short link: github -> https://github.com

$ ./shortlinker add github https://gitlab.com
❌ Error: Short code 'github' already exists, currently points to: https://github.com
💡 To overwrite, use --force parameter

Script Integration

Batch Operations

#!/bin/bash
# Batch import links
while IFS=',' read -r code url; do
    ./shortlinker add "$code" "$url"
done < links.csv

Error Checking

if ./shortlinker add test https://example.com; then
    echo "Added successfully"
else
    echo "Failed to add"
    exit 1
fi

Next Steps

• 📖 Check Detailed Command Reference for all options
• ⚙️ Learn Configuration Guide to customize behavior