@tgcloud/cli

The command-line tool for Telegram Serverless — run your bot's backend on Telegram's own infrastructure, with no server to host or scale. Write it in JavaScript, deploy with a single command, and manage your project, database, and bot right from the terminal.

Install

The CLI is normally a project-local dev-dependency. The fastest way to start a new project — which installs it for you — is:

npm create @tgcloud/bot example_bot

To add it to an existing project:

npm install -D @tgcloud/cli

Inside a project you run it with npx tgcloud <command>, or through the npm run scripts the scaffold sets up.

Requires Node.js 18 or newer.

Quick start

npx tgcloud init      # scaffold a project
npx tgcloud login     # link a bot
npx tgcloud push      # deploy

Run npx tgcloud --help to see every command.

Global install

You can also install the CLI globally if you'd rather run a bare tgcloud from any folder instead of npx tgcloud:

npm install -g @tgcloud/cli

Documentation

Full documentation: https://core.telegram.org/bots/serverless

License

MIT