Skip to main content

Discord transport plugin for takopi

Project description

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. Use @branch-name prefix to work on a specific branch, otherwise it creates a session on the base branch (e.g., master).

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 ~/dev/takopi
│   ├── feat/voice        ← thread on branch: feat/voice
│   └── fix typo          ← session on master
├── #discord              ← bound to ~/dev/takopi-discord
└── 🔊 Voice: feat/voice  ← voice channel linked to feat/voice thread

Installation

# Install takopi-discord
pip install takopi-discord

# Or with uv
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 = "stateless"       # "stateless" (default) or "chat"
show_resume_line = true          # Show resume token in messages (default: true)
upload_dir = "~/uploads"         # Optional: enable /file commands with this root dir

State is automatically saved to ~/.takopi/discord_state.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 setup and follow the prompts
  5. Invite the bot to your server using the generated URL

Slash Commands

Core Commands

  • /bind <project> [worktrees_dir] [default_engine] [worktree_base] - Bind channel to a project
  • /unbind - Remove project binding
  • /status - Show current channel/thread context and status
  • /ctx [show|clear] - Show or clear context binding
  • /cancel - Cancel running task
  • /new - Clear conversation session (start fresh)

Agent & Model Commands

  • /agent - Show available agents and current defaults
  • /model [engine] [model] - Show or set model override for an engine
  • /reasoning [engine] [level] - Show or set reasoning level (minimal/low/medium/high/xhigh)
  • /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)

Requires upload_dir to be configured. 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.

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 work on the base branch (e.g., master).

Thread Sessions

  • Messages in channels automatically create threads
  • Each thread maintains its own session with resume tokens
  • Multiple sessions can run simultaneously across threads
  • Cancel button appears on progress messages for task cancellation

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.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

takopi_discord-0.2.0.tar.gz (100.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

takopi_discord-0.2.0-py3-none-any.whl (56.8 kB view details)

Uploaded Python 3

File details

Details for the file takopi_discord-0.2.0.tar.gz.

File metadata

  • Download URL: takopi_discord-0.2.0.tar.gz
  • Upload date:
  • Size: 100.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for takopi_discord-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9e44ef143132ad277fabd9b8e81479deb92742ffef73718338e0ea30be6057aa
MD5 2c5f45b32d9d5c3ee37f3ce964c105c8
BLAKE2b-256 ffdf2f0e769c3113bf6c64eb1fb60f73b9f1cdb80e425da1184d1904695f3819

See more details on using hashes here.

Provenance

The following attestation bundles were made for takopi_discord-0.2.0.tar.gz:

Publisher: release.yml on asianviking/takopi-discord

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file takopi_discord-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: takopi_discord-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 56.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for takopi_discord-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8a9a89944845dd0f7f361ead6c01cbe172e496ff633b4152e5e3888fa5563fe
MD5 2971911a4b00a0184296b6de4333ff65
BLAKE2b-256 067fd1949cd84dac9d5996849c55f3ad06b7acb25c0081515a52eb91aa89aad6

See more details on using hashes here.

Provenance

The following attestation bundles were made for takopi_discord-0.2.0-py3-none-any.whl:

Publisher: release.yml on asianviking/takopi-discord

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page