takopi-discord 0.6.0

Discord transport plugin for takopi

takopi-discord

Discord transport plugin for takopi - "he just wants to help-pi... on Discord!"

Concept

Maps Discord's structure to takopi's project/branch/session model:

Discord	Takopi	Purpose
Category	(organization)	Visual grouping
Channel	Project	Repository context (bound via /bind)
Thread	Branch / Session	Feature branch or session on base branch
Voice Channel	Voice Session	Talk to the agent with speech

When you message in a channel, a thread is created on the channel's base branch (e.g., main). Use @branch-name prefix to start on a specific branch, or use /ctx set @branch-name inside the thread later. Thread-level /ctx set keeps the channel's project binding, prepares or reuses the branch worktree, and renames the Discord thread to match the branch.

Voice channels can be created with /voice and are linked to a thread's project/branch context. The bot joins, listens, and responds with speech.

Structure Example

TAKOPI (category)
├── #main                 ← bound to project alias: takopi
│   ├── feat/voice        ← thread on branch: feat/voice
│   └── fix typo          ← session on main
├── #discord              ← bound to project alias: takopi-discord
└── 🔊 Voice: feat/voice  ← voice channel linked to feat/voice thread

Installation

# Recommended: install into the takopi tool environment
uv tool install -U takopi --with takopi-discord

# If you're already inside a project virtual environment
uv pip install takopi-discord

# Verify the transport is loaded
takopi plugins --load

Configuration

# takopi.toml
transport = "discord"

[transports.discord]
bot_token = "..."                # Required: Discord bot token
guild_id = 123456789             # Optional: restrict bot to single server
message_overflow = "split"       # "split" (default) or "trim" for long messages
session_mode = "thread"          # "thread" (default) or "stateless"; "chat" aliases "thread"
show_resume_line = true          # Show resume token outside thread sessions (default: true)
trigger_mode_default = "all"     # "all" (default) or "mentions" for inherited trigger mode
# allowed_user_ids = [123456789012345678]      # Optional: restrict human bot usage (Discord user IDs)
# allowed_bot_user_ids = [987654321098765432]  # Optional: trusted bot senders allowed to trigger Takopi
media_group_debounce_s = 0.75     # Buffer bursts of attachments (seconds)

[transports.discord.files]
enabled = false                  # Enable /file + attachment auto-upload
# auto_put = true                # Auto-save attachments into `uploads_dir`
# auto_put_mode = "upload"       # "upload" (default) or "prompt"
uploads_dir = "incoming"         # Relative path in the repo
# max_upload_bytes = 20971520    # 20MB
# max_download_bytes = 10485760  # 10MB Discord base upload limit; raise for boosted/Nitro-capable servers
# deny_globs = [".git/**", ".env", ".envrc", "**/*.pem", "**/.ssh/**"]
# allowed_user_ids = [123456789012345678]  # Optional: restrict file transfers separately

[transports.discord.voice_messages]
enabled = false                  # Transcribe audio attachments with no text prompt
# max_bytes = 10485760           # 10MB
whisper_model = "base"
# voice_transcription_base_url = "http://localhost:8000/v1"  # Optional: local transcription server
# voice_transcription_api_key = "local"                      # Optional: key for transcription server

State is automatically saved to ~/.takopi/discord_state.json. Channel/thread preferences (trigger mode, engine overrides) are stored in ~/.takopi/discord_prefs.json.

Setup

1. Create a Discord application at https://discord.com/developers/applications
2. Create a bot and copy the token
3. Enable "Message Content Intent" under Privileged Gateway Intents
4. Run takopi --onboard --transport discord and follow the prompts
5. Register repos with takopi init <project-alias> so /bind can use those aliases
6. Invite the bot to your server using the generated URL

Troubleshooting

• error: No virtual environment found; run uv venv to create an environment, or pass --system ...
  • This happens when uv pip install ... is run outside a project venv.
  • If you installed Takopi with uv tool install, install this plugin with:
    • uv tool install -U takopi --with takopi-discord
• Error: No such command 'setup'
  • takopi setup is not a core command in current Takopi.
  • Use onboarding via:
    • takopi --onboard --transport discord
• Config changes without restarting
  • You can edit ~/.takopi/takopi.toml directly, or use the CLI:
    • takopi config set transports.discord.trigger_mode_default mentions
    • takopi config set transports.discord.voice_messages.enabled true
  • Enable watch_config = true for hot reload of command registrations.

Slash Commands

Core Commands

• /bind <project> [worktrees_dir] [default_engine] [worktree_base] - Bind channel to a configured Takopi project alias/key
• /unbind - Remove project binding
• /status - Show current channel/thread context and status
• /ctx [show|set|clear] - Show or modify context binding. In channels it can set the project/base branch; in threads it only sets the branch for that thread.
• /cancel - Cancel running task
• /new - Clear conversation session (start fresh)

Engine Commands

Dynamic slash commands are registered for each configured engine:

• /claude [prompt] - Send a message to Claude
• /codex [prompt] - Send a message to Codex
• /gemini [prompt] - Send a message to Gemini
• etc.

These commands allow you to target a specific engine regardless of the channel's default.

Agent & Model Commands

• /agent [show|set|clear] [engine] - Show or override the default agent for this channel/thread
• /model [engine] [model] - Show or set model override for an engine
• /reasoning [engine] [level] - Show or set reasoning level for Codex, Claude, or Pi (Claude also supports max)
• /trigger [all|mentions|clear] - Set when bot responds (all messages or only @mentions)

File Transfer

• /file get <path> - Download a file or directory (zipped) from the server
• /file put <path> - Upload a file (attach file, then reply with this command)

Enable with [transports.discord.files] enabled = true. Files in .git, .env, and credentials are blocked.

Voice

• /voice or /vc - Create a voice channel for the current thread/channel

The voice channel is bound to the project context and auto-deletes when empty. Uses local Whisper for speech-to-text transcription.

To transcribe voice message attachments in text chat, enable [transports.discord.voice_messages] (requires ffmpeg).

Plugins

Custom command plugins can extend the bot's functionality. Plugin commands are automatically registered as slash commands when loaded by takopi. When started from a bound project channel, plugin slash commands create a thread just like messages and engine slash commands; inside an existing thread, they run in that thread.

Plugin-owned Discord components can route back into command plugins by using a component custom_id of command:args or takopi-discord:command:command:args. The built-in cancel and steer component IDs are reserved.

Message Features

@branch Prefix

Start a conversation on a specific branch by prefixing with @branch-name:

@feat/new-feature implement the login page
@issue-123 fix the bug

This creates a new thread bound to the specified branch. Without a prefix, threads start on the channel's base branch (e.g., main).

Inside a thread, use /ctx set @branch-name to move that thread to a branch. The project is inherited from the parent channel, so thread-level /ctx set does not accept a project. Takopi prepares the branch worktree when the context is set, reusing an existing worktree/branch when one already exists, and the Discord thread name is updated to the branch name.

Thread Sessions

• Messages in channels automatically create threads
• Each thread maintains its own server-side session with resume tokens
• Multiple sessions can run simultaneously across threads
• Thread message footers omit resume-token and ctx: lines because the parent channel and thread name already identify the project and branch; use /ctx commands to inspect or change stored context
• session_mode = "stateless" disables server-side resume; reply-chain resume still works. Legacy session_mode = "chat" is treated the same as thread.
• Progress messages include Discord buttons for cancellation, and queued replies can be steered into an active turn when the runner supports it
• Rate limiting prevents Discord API throttling during high activity

Discord uses native threads for the same project/branch workflow that Telegram uses forum topics for. Start with @branch-name to create a branch-bound thread, or use /ctx set @branch-name inside an existing thread to bind it to a branch while keeping the parent channel's project.

Trigger Modes

Control when the bot responds:

• all (default): Respond to all messages in bound channels/threads
• mentions: Only respond when @mentioned or replied to

Set per-channel or per-thread with /trigger. Set the inherited fallback for new channels/threads with trigger_mode_default in [transports.discord].

Discord Bot Permissions Required

Text:

• Read Messages / View Channels
• Send Messages
• Create Public Threads
• Send Messages in Threads
• Manage Threads
• Read Message History
• Add Reactions
• Attach Files
• Use Slash Commands

Voice (optional, for /voice command):

• Connect
• Speak
• Manage Channels (to create/delete voice channels)

Development

# Clone the repo
git clone https://github.com/asianviking/takopi-discord.git
cd takopi-discord

# Install in development mode
uv pip install -e .

# Run tests
pytest

Requires Python ≥ 3.14.

License

MIT