Project Canis TG

A version of canis from WhatsApp!

⚠️ Warning: This repository is for educational and entertainment purposes only. Canis is not affiliated with Telegram. Use at your own risk, your Telegram account may be subject to suspension or bans.

⚠️ Warning: Spaghetting code ahead

Supported AI Providers

Canis supports multiple AI providers out of the box:

• OpenRouter
• OpenAI
• Groq
• Gemini (Google)
• Ollama

Prerequisites

• Node.js (>=18.x)
• MySQL
• Redis/Valkey
• Telegram Account

Skip through this long setup and use NPX

If you want to skip the setup and just want to run the bot, you can use NPX to run the bot without cloning the repo or installing dependencies.

npx project-canis-tg

Once you install the bot using NPX, you configure the required environment variables in the .env.example using this command

# Your bot name goes here
export PROJECT_CANIS_ALIAS=Canis

# the Telegram API ID and hash for your bot
export TELEGRAM_API_ID=
# the Telegram API hash for your bot
export TELEGRAM_API_HASH=
# for more configuration, please refer to the .env.example file

Alternatively, you can also run the bot using this short command:

npx canis-tg

Getting started

1. Clone repo

   git clone https://github.com/mrepol742/project-canis-tg.git
   cd project-canis-tg
   

2. Install dependencies

   npm install or pnpm i

3. Setup environment variables

   cp .env.example .env
   # Configure your AI Provider, models and other necessary preferences.

4. Run Migration

   npx prisma migrate dev

5. Run

   npm run dev

PM2

1. Build

   npm run build
   

2. Start

   pm2 start ecosystem.config.js
   

NodeJS

1. Build

   npm run build
   

2. Start

   npm run start
   

WhatsApp Version

A WhatsApp version of Project Canis is available at project-canis.

License

Copyright 2025 Melvin Jones Repol

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.