> ## Documentation Index
> Fetch the complete documentation index at: https://simili.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install Simili Bot v0.2.0

# 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](https://aistudio.google.com/app/apikeys).
3. **Search Backend (Optional)**:
   * **Qdrant**: Recommended for large orgs. Use [Qdrant Cloud](https://cloud.qdrant.io).
   * **GitHub Native**: Zero-config option (built-in).

***

## Deployment options

### GitHub Action (Recommended)

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`:

```yaml theme={null}
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 }}
          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.

```bash theme={null}
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.

```bash theme={null}
# Build from source
go build -o simili ./cmd/simili

# Check installation
./simili --version
```

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="API key is invalid">
    Double-check your Gemini API key in Google AI Studio and ensure the **Generative AI API** is enabled for your project.
  </Accordion>

  <Accordion title="Cannot connect to Qdrant">
    Ensure your Qdrant URL includes the correct port (usually `6333`) and that your API key has the necessary read/write permissions for the collection.
  </Accordion>
</AccordionGroup>

***

## Next steps

<CardGroup cols={3}>
  <Card title="Quick start (Pattern A)" href="/getting-started/single-repo-setup" icon="rocket" />

  <Card title="Configuration overview" href="/configuration/overview" icon="gear" />

  <Card title="Action reference" href="/setup/github-action-reference" icon="file-code" />
</CardGroup>