Skip to main content

Prerequisites

macOS is fully supported. Linux is alpha. See Platform Support.

Install

1

Install superturtle

2

Run the setup wizard

The wizard walks you through:
  1. Creating a Telegram bot via @BotFather
  2. Getting your Telegram user ID via @userinfobot
  3. Optionally enabling voice transcription (requires OPENAI_API_KEY)
Config is saved to .superturtle/.env.
3

Start the bot

This opens a project-scoped tmux session and attaches to it immediately. The bot survives terminal disconnects.
  • Re-attach: run superturtle start again, or use superturtle status to print the exact tmux attach command
  • Stop: superturtle stop
  • Status: superturtle status
4

Verify in Telegram

Open Telegram, find your bot, and send any message. You should get a response.

Non-interactive setup

For CI or scripted environments, pass flags directly:

Development setup

If you’re contributing to superturtle itself:
superturtle init installs dependencies, creates .superturtle/.env, and prompts for your tokens. In this repo, prefer the explicit node super_turtle/bin/superturtle.js ... form so you run the source checkout instead of any globally installed package. Optional defaults for testing model configuration:

Mac reliability notes

  • Enable System Settings > Battery > Options > Prevent automatic sleeping when the display is off (on power adapter).
  • Keep the lid open while the bot is running.

What’s next