Single Repository Setup

Get Simili Bot running in a single repository in 5 minutes (Pattern A)

Single Repository Setup

This guide will help you set up Simili Bot for a single repository. This is the Pattern A deployment model, which is the easiest way to get started.

Prerequisites

• A GitHub repository where you have admin access.
• Gemini API Key.
• Qdrant API Key & URL (Optional, for advanced semantic search).

---

Setup steps

Follow these steps to enable AI-powered issue management.

1. Add Configuration

   Create .github/simili.yaml in your repository root.

   Option 1: Zero-Config (GitHub Native)

   search:
     backend: "github_native"
   
   llm:
     api_key: "${GEMINI_API_KEY}"
   
   repositories:
     - org: "your-username"
       repo: "your-repo"
       enabled: true
   

   Option 2: Advanced (Qdrant)

   qdrant:
     url: "https://your-cluster.qdrant.io:6333"
     api_key: "${QDRANT_API_KEY}"
     collection: "my-repo-issues"
   
   embedding:
     provider: "gemini"
     api_key: "${GEMINI_API_KEY}"
     model: "gemini-embedding-001"
     dimensions: 3072
   
   repositories:
     - org: "your-username"
       repo: "your-repo"
       enabled: true
   
2. Store secrets

   Go to Settings > Secrets and variables > Actions in your GitHub repository and add:

   • GEMINI_API_KEY
   • QDRANT_API_KEY (Only if using Qdrant)
   • QDRANT_URL (Only if using Qdrant)
3. Create workflow

   Create .github/workflows/simili-bot.yml with the following content:

   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.2.0
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
             # Optional Qdrant secrets
             QDRANT_API_KEY: ${{ secrets.QDRANT_API_KEY }}
             QDRANT_URL: ${{ secrets.QDRANT_URL }}
   
4. Verification

   Open a new issue in your repository. You should see Simili Bot comment within a few seconds with its analysis.

---

Troubleshooting

Bot is not commenting

Check the Actions tab in your repository. If the workflow failed, review the logs for authentication or configuration errors.

Unauthorized Error

Ensure your QDRANT_API_KEY and GEMINI_API_KEY are correctly set in the repository secrets and match the environment variable names in your workflow.

---

Next Steps

Configuration overview

Feature guides