kimaki  by remorses

AI coding agent control via Discord

Created 5 months ago
385 stars

Top 74.7% on SourcePulse

GitHubView on GitHub
Project Summary

<2-3 sentences summarising what the project addresses and solves, the target audience, and the benefit.> Kimaki is a Discord bot designed to integrate AI coding agents (OpenCode) directly into development workflows. It allows users to control code editing, file manipulation, and terminal commands on their local machine through conversational messages within Discord channels. This offers a novel, accessible interface for AI-assisted development, enabling developers to "text" their codebase and receive AI-driven assistance.

How It Works

The core architecture links each Discord channel to a specific project directory on the user's machine. When a message is sent, Kimaki spawns or reuses an OpenCode server instance locally to process the request. This server interacts with the codebase, runs commands, and manages AI sessions. A key design choice is the "one bot per machine" model, ensuring security and local access control; controlling multiple machines necessitates deploying separate Kimaki instances, each with its own Discord bot token.

Quick Start & Requirements

  • Installation: Run npx -y kimaki@latest to initiate an interactive setup wizard.
  • Prerequisites: Node.js, a Discord Bot application created via the Discord Developer Portal, and enabling specific bot intents (Message Content, Server Members, Voice States). An optional Google Gemini API key is required for voice features. The CLI must remain running to bridge Discord and the local machine.
  • Setup: The wizard guides through bot creation, configuration, server invitation, and project channel setup.

Highlighted Details

  • Conversational Code Control: Interact with AI agents by sending text or file attachments in Discord channels linked to local projects.
  • Voice Integration: Supports voice messages (transcribed via Gemini) and real-time voice channel interactions, mimicking a "Jarvis" experience.
  • Advanced Session Management: Features include message queuing, session resuming, forking, sharing, and undo/redo capabilities.
  • CI/Automation: Programmatically start sessions or send notifications via CLI commands, integrating with workflows like GitHub Actions.
  • Scalability: Supports running multiple isolated bot instances on a single machine and managing a single bot across numerous Discord servers.

Maintenance & Community

No specific details regarding maintainers, community channels (e.g., Discord/Slack), or roadmap were found in the provided README.

Licensing & Compatibility

The README does not specify the project's license or provide compatibility notes for commercial use.

Limitations & Caveats

  • Local Machine Dependency: Each bot instance is strictly tied to the machine it runs on, limiting direct access to local files only.
  • Permission Model: Interaction is restricted to users with specific Discord permissions (Administrator, Manage Server, or a custom "Kimaki" role).
  • Voice Feature Dependency: Voice capabilities require a Google Gemini API key.
Health Check
Last Commit

3 days ago

Responsiveness

Inactive

Pull Requests (30d)
3
Issues (30d)
24
Star History
204 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.