@tinyurl-ca/cli 1.0.1

package/README.md

@@ -0,0 +1,139 @@
+# TinyURL.ca CLI
+
+Command-line tool for creating and managing short links from your terminal.
+
+## Installation
+
+```bash
+npm install -g @tinyurl-ca/cli
+```
+
+## Quick Start
+
+### 1. Configure your API key
+
+```bash
+tinyurl config --key YOUR_API_KEY
+```
+
+Get your API key from https://tinyurl.ca/dashboard/settings
+
+### 2. Shorten a URL
+
+```bash
+tinyurl shorten https://example.com
+```
+
+## Commands
+
+### `config`
+Configure your API key
+
+```bash
+tinyurl config --key YOUR_API_KEY
+```
+
+### `shorten`
+Create a new short link
+
+```bash
+# Basic usage
+tinyurl shorten https://example.com
+
+# Custom short code
+tinyurl shorten https://example.com --custom my-link
+
+# Add title
+tinyurl shorten https://example.com --title "My Website"
+
+# Set expiration (30 days)
+tinyurl shorten https://example.com --expires 2592000
+
+# Show QR code
+tinyurl shorten https://example.com --qr
+```
+
+### `list`
+List your short links
+
+```bash
+# List 20 most recent links
+tinyurl list
+
+# List 50 links
+tinyurl list --limit 50
+```
+
+### `get`
+Get details of a specific link
+
+```bash
+tinyurl get LINK_ID
+
+# Show with QR code
+tinyurl get LINK_ID --qr
+```
+
+### `delete`
+Delete a short link
+
+```bash
+tinyurl delete LINK_ID
+
+# Alias
+tinyurl rm LINK_ID
+```
+
+### `stats`
+Get analytics for a link
+
+```bash
+tinyurl stats LINK_ID
+```
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `-k, --key <apiKey>` | Your API key |
+| `-c, --custom <code>` | Custom short code |
+| `-t, --title <title>` | Link title |
+| `-e, --expires <seconds>` | Expiration time in seconds |
+| `-q, --qr` | Show QR code |
+| `-l, --limit <number>` | Number of items to display |
+
+## Examples
+
+### Create a link with custom code
+```bash
+tinyurl shorten https://mywebsite.com --custom promo2024
+# → https://tinyurl.ca/promo2024
+```
+
+### Create temporary link (expires in 1 hour)
+```bash
+tinyurl shorten https://example.com --expires 3600
+```
+
+### List last 100 links
+```bash
+tinyurl list --limit 100
+```
+
+## Environment Variables
+
+You can also set your API key via environment variable:
+
+```bash
+export TINYURL_API_KEY=your_api_key_here
+```
+
+## License
+
+MIT
+
+## Support
+
+- Documentation: https://tinyurl.ca/docs
+- Issues: https://github.com/raj-iwt/tinyurl-cli/issues
+- Email: support@tinyurl.ca

package/bin/cli.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import * as commands from '../dist/commands.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const packageJson = JSON.parse(readFileSync(join(__dirname, '../package.json'), 'utf-8'));
+const { version } = packageJson;
+
+const program = new Command();
+
+program
+  .name('tinyurl')
+  .description('TinyURL.ca CLI - Create and manage short links from your terminal')
+  .version(version);
+
+// Configure API key
+program
+  .command('config')
+  .description('Configure your API key')
+  .option('-k, --key <apiKey>', 'Your TinyURL.ca API key')
+  .action(commands.config);
+
+// Create a short link
+program
+  .command('shorten')
+  .description('Create a new short link')
+  .argument('<url>', 'URL to shorten')
+  .option('-c, --custom <code>', 'Custom short code')
+  .option('-t, --title <title>', 'Link title')
+  .option('-e, --expires <seconds>', 'Expiration time in seconds')
+  .option('-q, --qr', 'Show QR code')
+  .action(commands.shorten);
+
+// List all links
+program
+  .command('list')
+  .description('List your short links')
+  .option('-l, --limit <number>', 'Number of links to display', '20')
+  .action(commands.list);
+
+// Get link details
+program
+  .command('get')
+  .description('Get details of a specific link')
+  .argument('<id>', 'Link ID or short code')
+  .option('-q, --qr', 'Show QR code')
+  .action(commands.get);
+
+// Delete a link
+program
+  .command('delete')
+  .alias('rm')
+  .description('Delete a short link')
+  .argument('<id>', 'Link ID to delete')
+  .action(commands.deleteLink);
+
+// Get link analytics
+program
+  .command('stats')
+  .description('Get analytics for a link')
+  .argument('<id>', 'Link ID or short code')
+  .action(commands.stats);
+
+program.parse();

package/dist/commands.d.ts

@@ -0,0 +1,12 @@
+export declare function config(options: {
+    key?: string;
+}): Promise<void>;
+export declare function shorten(url: string, options: any): Promise<void>;
+export declare function list(options: {
+    limit: string;
+}): Promise<void>;
+export declare function get(id: string, options: {
+    qr?: boolean;
+}): Promise<void>;
+export declare function deleteLink(id: string): Promise<void>;
+export declare function stats(id: string): Promise<void>;

package/dist/commands.js

@@ -0,0 +1,162 @@
+import axios from 'axios';
+import Conf from 'conf';
+import chalk from 'chalk';
+import ora from 'ora';
+import Table from 'cli-table3';
+import qrcode from 'qrcode-terminal';
+const store = new Conf({ projectName: 'tinyurl-cli' });
+const API_BASE = 'https://tinyurl.ca/api/v1';
+// Helper to get API client
+function getApiClient() {
+    const apiKey = store.get('apiKey');
+    if (!apiKey) {
+        console.log(chalk.red('❌ API key not configured'));
+        console.log(chalk.yellow('Run: tinyurl config --key YOUR_API_KEY'));
+        process.exit(1);
+    }
+    return axios.create({
+        baseURL: API_BASE,
+        headers: {
+            'X-API-Key': apiKey,
+            'Content-Type': 'application/json',
+        },
+    });
+}
+// Configure API key
+export async function config(options) {
+    if (options.key) {
+        store.set('apiKey', options.key);
+        console.log(chalk.green('✓ API key configured successfully'));
+        console.log(chalk.gray('You can now use the CLI to create short links'));
+    }
+    else {
+        const currentKey = store.get('apiKey');
+        if (currentKey) {
+            console.log(chalk.blue('Current API key:'), chalk.gray(currentKey.substring(0, 20) + '...'));
+        }
+        else {
+            console.log(chalk.yellow('No API key configured'));
+            console.log(chalk.gray('Run: tinyurl config --key YOUR_API_KEY'));
+        }
+    }
+}
+// Shorten a URL
+export async function shorten(url, options) {
+    const spinner = ora('Creating short link...').start();
+    try {
+        const api = getApiClient();
+        const response = await api.post('/links', {
+            url,
+            customCode: options.custom,
+            title: options.title,
+            expiresIn: options.expires ? parseInt(options.expires) : null,
+        });
+        spinner.succeed('Short link created!');
+        const { data } = response.data;
+        console.log('');
+        console.log(chalk.green.bold('✓ Success!'));
+        console.log('');
+        console.log(chalk.cyan('Short URL:'), chalk.bold.underline(data.shortUrl));
+        console.log(chalk.gray('Original:'), data.originalUrl);
+        if (data.title) {
+            console.log(chalk.gray('Title:'), data.title);
+        }
+        console.log(chalk.gray('Created:'), new Date(data.createdAt).toLocaleString());
+        if (options.qr) {
+            console.log('');
+            qrcode.generate(data.shortUrl, { small: true });
+        }
+    }
+    catch (error) {
+        spinner.fail('Failed to create short link');
+        console.log(chalk.red('Error:'), error.response?.data?.error || error.message);
+        process.exit(1);
+    }
+}
+// List links
+export async function list(options) {
+    const spinner = ora('Fetching your links...').start();
+    try {
+        const api = getApiClient();
+        const response = await api.get('/links', {
+            params: { limit: options.limit }
+        });
+        spinner.stop();
+        const { data } = response.data;
+        if (data.length === 0) {
+            console.log(chalk.yellow('No links found'));
+            return;
+        }
+        const table = new Table({
+            head: ['Short Code', 'Original URL', 'Clicks', 'Created'].map(h => chalk.cyan(h)),
+            colWidths: [15, 50, 10, 20],
+        });
+        data.forEach((link) => {
+            table.push([
+                chalk.bold(link.shortCode),
+                link.originalUrl.substring(0, 47) + '...',
+                link.clicks.toString(),
+                new Date(link.createdAt).toLocaleDateString(),
+            ]);
+        });
+        console.log('');
+        console.log(table.toString());
+        console.log('');
+        console.log(chalk.gray(`Showing ${data.length} links`));
+    }
+    catch (error) {
+        spinner.fail('Failed to fetch links');
+        console.log(chalk.red('Error:'), error.response?.data?.error || error.message);
+        process.exit(1);
+    }
+}
+// Get link details
+export async function get(id, options) {
+    const spinner = ora('Fetching link details...').start();
+    try {
+        const api = getApiClient();
+        const response = await api.get(`/links/${id}`);
+        spinner.succeed('Link found!');
+        const { data } = response.data;
+        console.log('');
+        console.log(chalk.cyan.bold('Link Details'));
+        console.log('');
+        console.log(chalk.gray('ID:'), data.id);
+        console.log(chalk.gray('Short Code:'), chalk.bold(data.shortCode));
+        console.log(chalk.gray('Short URL:'), chalk.bold.underline(data.shortUrl));
+        console.log(chalk.gray('Original URL:'), data.originalUrl);
+        if (data.title) {
+            console.log(chalk.gray('Title:'), data.title);
+        }
+        console.log(chalk.gray('Clicks:'), chalk.bold(data.clicks));
+        console.log(chalk.gray('Created:'), new Date(data.createdAt).toLocaleString());
+        if (options.qr) {
+            console.log('');
+            qrcode.generate(data.shortUrl, { small: true });
+        }
+    }
+    catch (error) {
+        spinner.fail('Failed to fetch link');
+        console.log(chalk.red('Error:'), error.response?.data?.error || error.message);
+        process.exit(1);
+    }
+}
+// Delete link
+export async function deleteLink(id) {
+    const spinner = ora('Deleting link...').start();
+    try {
+        const api = getApiClient();
+        await api.delete(`/links/${id}`);
+        spinner.succeed('Link deleted successfully!');
+    }
+    catch (error) {
+        spinner.fail('Failed to delete link');
+        console.log(chalk.red('Error:'), error.response?.data?.error || error.message);
+        process.exit(1);
+    }
+}
+// Get stats (placeholder)
+export async function stats(id) {
+    console.log(chalk.yellow('Analytics feature coming soon!'));
+    console.log(chalk.gray('Use the web dashboard at https://tinyurl.ca/dashboard for detailed analytics'));
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@tinyurl-ca/cli",
+  "version": "1.0.1",
+  "description": "Command-line tool for TinyURL.ca - create and manage short links from your terminal",
+  "type": "module",
+  "bin": {
+    "tinyurl": "./bin/cli.js"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "url-shortener",
+    "tinyurl",
+    "cli",
+    "short-links",
+    "tiny url canada"
+  ],
+  "author": "TinyURL.ca",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^11.1.0",
+    "axios": "^1.6.0",
+    "chalk": "^5.3.0",
+    "ora": "^8.0.1",
+    "conf": "^12.0.0",
+    "cli-table3": "^0.6.3",
+    "qrcode-terminal": "^0.12.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "typescript": "^5.3.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/raj-iwt/linksnap.git",
+    "directory": "cli"
+  },
+  "homepage": "https://tinyurl.ca/docs"
+}