Skip to main content

​
Installation

Simili Bot can be deployed in various ways to suit your environment. Choose the method that best fits your workflow.

​
Prerequisites

Before you begin, ensure you have the following credentials ready:
  1. GitHub Account with access to your repositories.
  2. Google Gemini API Key: Obtain one from Google AI Studio.
  3. Qdrant Vector Database: Use Qdrant Cloud for a managed instance or host your own.

​
Deployment Options

The easiest way to get started. Simili Bot runs automatically on your chosen issue events. Add this step to your .github/workflows/simili-bot.yml: 
name: Simili Bot
on:
  issues:
    types: [opened, edited]
jobs:
  simili:
    runs-on: ubuntu-latest
    permissions:
      issues: write
      contents: read
    steps:
      - uses: similigh/simili-bot@v0.1.0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          QDRANT_URL: ${{ secrets.QDRANT_URL }}
          QDRANT_API_KEY: ${{ secrets.QDRANT_API_KEY }}
          GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}

​
Docker

Ideal for self-hosted environments or custom CI/CD pipelines. 
docker run -e QDRANT_URL="..." \
           -e QDRANT_API_KEY="..." \
           -e GEMINI_API_KEY="..." \
           -e GITHUB_TOKEN="..." \
           -v $(pwd)/config:/config \
           simili-bot:latest \
           process --config /config/simili.yaml

​
Binary

For those who prefer running native executables. 
# Build from source
go build -o simili ./cmd/simili

# Check installation
./simili --version

​
Troubleshooting

Double-check your Gemini API key in Google AI Studio and ensure the Generative AI API is enabled for your project.
Ensure your Qdrant URL includes the correct port (usually 6333) and that your API key has the necessary read/write permissions for the collection.

​
Next Steps

Quick Start (Pattern A)

Configuration Overview

Action Reference