JSPM

  • Created
  • Published
  • Downloads 849
  • Score
    100M100P100Q97389F
  • License MIT

Bridge local AI coding agents (Claude Code, Gemini CLI) to Telegram

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@atticux/cc-connect) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    CC-Connect Banner

    CI Status Release npm downloads License Go Report Card

    Telegram

    English | 中文


    Control your local AI agents from Telegram. Anywhere, anytime.

    cc-connect bridges AI agents running on your machine to Telegram.
    Code review, research, automation, data analysis — anything an AI agent can do,
    now accessible from your phone, tablet, or any device with a chat app.

    CC-Connect Architecture


    ✨ Why cc-connect?

    🤖 Universal Agent Support

    2 AI Agents — Claude Code, Gemini CLI. Use whichever fits your workflow, or both at once.

    📱 Simple & Reliable

    Telegram Platform — No public IP required, reliable long polling connection.

    🔄 Multi-Agent Orchestration

    Multi-Bot Relay — Bind multiple bots in a group chat and let them communicate with each other. Ask Claude, get insights from Gemini — all in one conversation.

    🎮 Complete Chat Control

    Full Control from Chat — Switch models (/model), change permission modes (/mode), manage sessions, all via slash commands.

    🧠 Persistent Memory

    Agent Memory — Read and write agent instruction files (/memory) without touching the terminal.

    ⏰ Intelligent Scheduling

    Scheduled Tasks — Set up cron jobs in natural language. "Every day at 6am, summarize GitHub trending" just works.

    🎤 Multimodal Support

    Voice & Images — Send voice messages or screenshots; cc-connect handles STT/TTS and multimodal forwarding.

    📦 Multi-Project Architecture

    Multi-Project — One process, multiple projects, each with its own agent + platform combo.

    🌍 Multilingual Interface

    5 Languages — Native support for English, Chinese (Simplified & Traditional), Japanese, and Spanish. Built-in i18n ensures everyone feels at home.


    🚀 Quick Start

    The easiest way — Send this to Claude Code or any AI coding agent, and it will handle the entire installation and configuration for you:

    Follow https://raw.githubusercontent.com/AtticusZeller/cc-connect/refs/heads/main/INSTALL.md to install and configure cc-connect.

    📦 Manual Install

    Via npm:

    # Stable version
    npm install -g @atticux/cc-connect
    
    # Beta version (more features, may be unstable)
    npm install -g @atticux/cc-connect@beta

    Download binary from GitHub Releases:

    # Linux amd64 - Stable
    curl -L -o cc-connect https://github.com/AtticusZeller/cc-connect/releases/latest/download/cc-connect-linux-amd64
    chmod +x cc-connect
    sudo mv cc-connect /usr/local/bin/
    
    # Beta version (from pre-release)
    curl -L -o cc-connect https://github.com/AtticusZeller/cc-connect/releases/download/v1.x.x-beta/cc-connect-linux-amd64

    Build from source (requires Go 1.22+):

    git clone https://github.com/AtticusZeller/cc-connect.git
    cd cc-connect
    make build

    ⚙️ Configure

    mkdir -p ~/.cc-connect
    cp config.example.toml ~/.cc-connect/config.toml
    vim ~/.cc-connect/config.toml

    ▶️ Run

    ./cc-connect

    🔄 Upgrade

    # npm
    npm install -g @atticux/cc-connect
    
    # Binary self-update
    cc-connect update           # Stable
    cc-connect update --pre     # Beta (includes pre-releases)

    📊 Support Matrix

    Component Type Status
    Agent Claude Code ✅ Supported
    Agent Gemini CLI (Google) ✅ Supported
    Platform Telegram ✅ Long Polling — no public IP needed

    📖 Platform Setup Guides

    Platform Guide Connection Public IP?
    Telegram docs/telegram.md Long Polling No

    🎯 Key Features

    💬 Session Management

    /new [name]       Start a new session
    /list             List all sessions
    /switch <id>      Switch session
    /current          Show current session

    🔐 Permission Modes

    /mode             Show available modes
    /mode yolo        # Auto-approve all tools
    /mode default     # Ask for each tool

    🔄 Provider Management

    /provider list              List providers
    /provider switch <name>     Switch API provider at runtime

    🤖 Model Selection

    /model                      List available models (format: alias - model)
    /model <alias>              Switch to model by alias

    ⏰ Scheduled Tasks

    /cron add 0 6 * * * Summarize GitHub trending

    📎 Agent Attachment Send-Back

    When an agent generates a local screenshot, chart, PDF, bundle, or other file, it can send that attachment back to the current chat.

    Supported platforms:

    • Telegram

    If your agent does not natively inject a system prompt, run this once in chat after upgrading:

    /bind setup

    or:

    /cron setup

    This refreshes the cc-connect instructions in the project memory file so the agent knows how to send attachments back.

    You can control this feature globally in config.toml:

    attachment_send = "on"  # default: "on"; set to "off" to block image/file send-back

    This switch is independent from the agent's /mode. It only controls cc-connect send --image/--file.

    Examples:

    cc-connect send --image /absolute/path/to/chart.png
    cc-connect send --file /absolute/path/to/report.pdf
    cc-connect send --file /absolute/path/to/report.pdf --image /absolute/path/to/chart.png

    Notes:

    • Absolute paths are the safest option.
    • --image and --file can both be repeated.
    • attachment_send = "off" disables only attachment send-back; ordinary text replies still work.
    • This command is for generated attachments, not ordinary text replies.

    📖 Full documentation: docs/usage.md


    📚 Documentation


    👥 Community


    🙏 Contributors


    ⭐ Star History

    Star History Chart

    📄 License

    MIT License


    Built with ❤️ by the cc-connect community