Skip to content

Getting started

Pick 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 and learning how Osmia works.

    Docker Compose quick start

  • Deploy to Kubernetes

    Deploy Osmia with Helm on any Kubernetes cluster.

    Best for Kubernetes engineers, production deployments and 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

    Picks up GitHub issues labelled osmia, posts results to Slack and opens pull requests.

    GitHub Issues + Slack guide

  • Shortcut + Slack

    Picks up Shortcut stories assigned to @osmia, moves them through workflow states and posts results to Slack.

    Shortcut + Slack guide

  • Linear + Slack

    Picks up Linear issues labelled osmia, tracks them with labels and posts results to Slack.

    Linear + Slack guide

After setup