Skip to content

Getting Started

Welcome to Osmia! Choose the path that fits your situation.

Step 1 — Deploy Osmia

  • Try it locally first

    No Kubernetes cluster needed. Get Osmia running with Docker Compose in 5 minutes.

    Best for: first-time users, quick evaluation, learning how Osmia works.

    Docker Compose quick start

  • Deploy to Kubernetes

    Deploy Osmia with Helm on any Kubernetes cluster.

    Best for: K8s engineers, production deployments, team evaluations.

    Kubernetes quick start

Step 2 — Connect your tools

Once Osmia is running, follow the guide for your ticketing and notification setup:

  • GitHub Issues + Slack

    Pick up GitHub issues labelled osmia, post results to Slack, and open pull requests automatically.

    GitHub Issues + Slack guide

  • Shortcut + Slack

    Pick up Shortcut stories assigned to @osmia, move them through workflow states, and post results to Slack.

    Shortcut + Slack guide

After Setup