Quickstart

Get Kimaki running in under 2 minutes with this quick setup guide.

Get Kimaki up and running in under 2 minutes.

Run the CLI

npx -y kimaki@latest

That’s it. The CLI guides you through everything.

What happens during setup

The setup wizard walks you through:

1. Create a Discord bot

   The wizard will prompt you to:

   1. Go to discord.com/developers/applications
   2. Click “New Application” and give it a name
   3. Enable required intents in the “Bot” section:
      • SERVER MEMBERS INTENT
      • MESSAGE CONTENT INTENT
   4. Copy your bot token (click “Reset Token” if needed)
2. Install bot to your server

   The CLI generates an invite link with proper permissions. Click it to add the bot to your Discord server.

3. Select projects

   Choose which OpenCode projects to add as Discord channels. The CLI will create a channel for each selected project.

4. Keep it running

   Leave the CLI process running - it’s the bridge between Discord and your machine.

Your first message

Once setup is complete, you’ll see output like this:

┌  🚀 Ready to Use
│
│  Your kimaki channels are ready! Click any link below to open in Discord:
│
│  • #my-project: https://discord.com/channels/123.../456...
│
│  Send a message in any channel to start using OpenCode!
│
└

┌  ⚠️  Keep Running
│
│  Leave this process running to keep the bot active.
│
│  If you close this process or restart your machine, run `npx kimaki` again
│  to start the bot.
│
└

✨ Setup complete! Listening for new messages... do not close this process.

Click one of the channel links, then send any message:

Add a README.md file with setup instructions

Kimaki will create a thread and start an OpenCode session. The AI will read your codebase, create the file, and reply with what it did.

Example session

Here’s what a typical interaction looks like:

You (in Discord)

Add a README.md with installation and usage instructions

Click the file reference (/README.md:1) to jump to that line in your editor.

Next steps

Installation guide

Learn about all configuration options and advanced setup

CLI commands

Explore CLI commands for automation

Best practices

Set up permissions, roles, and workflows

Automation

Trigger sessions from CI, cron jobs, or GitHub Actions

If you close the CLI process, the bot stops working. Run npx kimaki again to restart it. Your configuration is saved in ~/.kimaki/.