Get started in 15 minutes
      Back to home
      1. Help Center
      2. Getting Started
      3. Get started in 15 minutes

      Get started with these 4 steps

      Get started with Swarmia by connecting with GitHub, your issue tracker, and Slack

      Swarmia is a software engineering intelligence platform for modern engineering organizations. By connecting your codebase and issue tracker, Swarmia gives everyone in your engineering organization the insights they need to build the right things faster.

      This guide helps you install Swarmia to your GitHub organization and connect your issue tracker and Slack workspace in preparation for team setup. 

      Step 1: Install Swarmia to GitHub

      To install the app, make sure you have the necessary admin permissions on GitHub and find Swarmia in the GitHub Marketplace. Click Install, review the necessary authorizations, and click Install & Authorize. You will then be taken to the onboarding wizard. Give a name for your organization and click Next.

      💁‍♀️ Review your GitHub teams. Swarmia uses GitHub to manage access to the app. Ensure that your GitHub teams reflect your actual organization and that all your intended Swarmia users have a GitHub account and belong to your GitHub organization. In case you do not have any teams in GitHub yet, you can also create teams within Swarmia.

      ⚠️ Note: All users in your organization can read the metadata (such as Pull Request names) for all integrated repositories in Swarmia. Use caution if working with sensitive repositories.

      ⚠️ Note: Swarmia collects the file names and size of commits from the source code. We do not store your source code! More information is available on the Data Security page.

      ⚠️ Note: If you have open source projects and don't want to see data from them in Swarmia, you can manually select the repositories you want to connect during onboarding.

      Step 2: Connect your issue tracker (optional)

      Connecting Jira

      • Learn how to setup your Jira integration with Swarmia here.
      • Configure Jira Team and Organization settings to access the full functionality of Swarmia. 

      Connecting Linear

      • If you’re using Linear as your issue tracker, follow these instructions to set up the integration.
      • You'll also find instructions how to assign the work in Linear teams to teams on Swarmia.

      Step 3: Connect your Slack workspace (optional)

      In the onboarding wizard, or in Slack settings in Swarmia, click Integrate Slack. Sign in to your Slack workspace, review the permissions, and click Allow.

      Step 4: Create teams and invite users

      To ensure data quality, your organization's Contributors list shouldn't include duplicate identities. In Contributor settings in Swarmia, review the automatically generated merge suggestions and click Merge. We don't always catch every duplicate, so it's a good idea to go through the list of Contributors and merge any remaining duplicate identities by selecting their checkboxes and clicking Merge.

      After merging the contributors, you can create and onboard your teams.


      We're here for you

      Our team is ready to help you throughout the installation and onboarding. If you have any questions or feedback, don't hesitate to get in touch through chat or email at hello@swarmia.com.