⚡ Sink

A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare.

<a href="https://trendshift.io/repositories/10421" target="_blank"> <img src="https://trendshift.io/api/badge/repositories/10421" alt="miantiao-me/Sink | Trendshift" width="250" height="55" /> </a> <a href="https://news.ycombinator.com/item?id=40843683" target="_blank"> <img src="https://hackernews-badge.vercel.app/api?id=40843683" alt="Featured on Hacker News" width="250" height="55" /> </a> <a href="https://hellogithub.com/repository/57771fd91d1542c7a470959b677a9944" target="_blank"> <img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=57771fd91d1542c7a470959b677a9944&claim_uid=qi74Zp23wYKeAVB&theme=neutral" alt="Featured｜HelloGitHub" width="250" height="55" /> </a> <a href="https://www.uneed.best/tool/sink" target="_blank"> <img src="https://www.uneed.best/POTW1.png" alt="Uneed Badge" width="250" height="55" /> </a>

<img src="https://devin.ai/assets/deepwiki-badge.png" alt="DeepWiki" height="20"/>

---

✨ Features

• 🔗 URL Shortening: Compress your URLs to their minimal length.
• 📈 Analytics: Monitor link analytics and gather insightful statistics.
• ☁️ Serverless: Deploy without the need for traditional servers.
• 🎨 Customizable Slug: Support for personalized slugs and case sensitivity.
• 🪄 AI Slug: Leverage AI to generate slugs.
• ⏰ Link Expiration: Set expiration dates for your links.
• 📱 Device Routing: Redirect iOS/Android users to different URLs (App Store links).
• 🖼️ OpenGraph Preview: Custom social media previews with title, description, and image.
• 📊 Real-time Analytics: Live 3D globe visualization and real-time event logs.
• 🔲 QR Code: Generate QR codes for your short links.
• 📦 Import/Export: Bulk migration via JSON/CSV files.
• 🌍 Multi-language: Full i18n support for the dashboard.
• 🌙 Dark Mode: Light, dark, and system theme support.

🪧 Demo

Experience the demo at Sink.Cool. Log in using the Site Token below:

Site Token: SinkCool

<details> <summary><b>Screenshots</b></summary> <img alt="Analytics" src="./docs/images/sink.cool_dashboard.png"/> <img alt="Links" src="./docs/images/sink.cool_dashboard_links.png"/> <img alt="Link Analytics" src="./docs/images/sink.cool_dashboard_link_slug.png"/> </details>

🧱 Technologies Used

• Framework: Nuxt
• Database: Cloudflare Workers KV
• Analytics Engine: Cloudflare Workers Analytics Engine
• UI Components: shadcn-vue
• Styling: Tailwind CSS
• Deployment: Cloudflare

🚗 Roadmap [WIP]

We welcome your contributions and PRs.

• [x] Browser Extension - Sink Tool
• [x] Chrome Extension - Sink Quick Shorten
• [x] Raycast Extension - Raycast-Sink
• [x] Apple Shortcuts - Sink Shortcuts
• [x] iOS App - Sink
• [ ] Enhanced Link Management (with Cloudflare D1)
• [ ] Analytics Enhancements (Support for merging filter conditions)
• [ ] Dashboard Performance Optimization (Infinite loading)
• [ ] Units Test

🏗️ Deployment

Video tutorial: Watch here

We currently support deployment to Cloudflare Workers (recommended) and Cloudflare Pages.

⚒️ Configuration

Configuration Docs

🔌 API

API Docs

🤖 AI Skills

Install Sink AI Skills for enhanced coding assistance:

npx skills add miantiao-me/sink

🧰 MCP

We currently do not support native MCP Server, but we have OpenAPI documentation, and you can use the following method to support MCP.

Replace the domain name in OPENAPI_SPEC_URL with your own domain name.

The API_KEY is the same as the NUXT_SITE_TOKEN in the environment variables.

{
  "mcpServers": {
    "sink": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
        "OPENAPI_SPEC_URL": "https://sink.cool/_docs/openapi.json",
        "API_KEY": "SinkCool",
        "TOOL_WHITELIST": "/api/link"
      }
    }
  }
}

🙋🏻 FAQs

FAQs

💖 Credits

1. Cloudflare
2. NuxtHub
3. Astroship
4. Tailark

☕ Sponsor

1. Follow Me on X(Twitter).
2. Become a sponsor to on GitHub.