Add Inkeep AI Assistant to GitHub

Overview

You can add Inkeep's AI Assistant to your GitHub repositories to help scale support to your users. The assistant automatically responds to GitHub issues and discussions using your knowledge base, providing instant help to users while reducing the workload on your maintainers.

How to install

Step 1: Create the assistant

To install Inkeep in Github, follow these steps:

1. Open the Inkeep Dashboard

2. Navigate to the Assistants tab within the desired project

3. Click on Create Assistant

4. From the dropdown menu, choose GitHub Assistant

5. Fill in the required field Name.

6. Click Add Item, then enter the full name of the repository you want the assistant to access. This should be in the format: organization-name/repository-name.

7. Click on Enable public responses if you want responses to be posted publicly. Otherwise, all responses will be posted in preview mode.

8. Click on Connect. A popup will then appear prompting you to install the Inkeep assistant in GitHub.

Step 2: Choose organization and repos

1. Inside the popup, click onto the organization where you want to install Inkeep-AI-Assistant

2. Select which repositories you want to install your Inkeep assistant on. Installation requires Admin permissions on the repository. If you lack Admin access, your request will be routed to an Admin for approval.

3. Click on Install

Event types

Under your assistant’s Settings, you can choose which GitHub event types Inkeep AI Assistant will respond to:

• Issues (default: enabled)
• Discussions (default: disabled)

Toggle each on or off depending on your needs. The bot will only evaluate and post replies for the event types you’ve enabled.

Enable for only certain Github Discussion Categories

Under Advanced settings, you can specify which categories Inkeep AI Assistant should respond to. By default, it will respond to all discussion categories.

Preview mode

How to preview responses

By default, your Inkeep assistant operates in preview mode and won't reply to issues and discussions publicly. This safety feature lets you preview all responses in Chat Sessions before enabling public replies (also known as live mode). To preview responses, follow these steps:

1. Open the Inkeep Dashboard

2. Navigate to the Chat Sessions tab within the desired project

3. Select Assistant and choose the GitHub integration to filter on

4. A list of all the responses will be shown.

How to switch to live mode

1. Open the Inkeep Dashboard

2. Navigate to the Assistants tab within the desired project

3. Click on the assistant you want to enable public responses for

4. Toggle Enable public responses on

5. Click on Update

When the assistant will reply

Trigger 1: When a new issue or discussion is created

Whenever you open a new issue or discussion the assistant evaluates its confidence via a built‑in Inkeep meter. If its confidence score meets the threshold for a confident response, it will post that reply as a GitHub comment.

Trigger 2: When an issue is reopened

When you reopen a previously closed issue, the assistant will automatically evaluate the situation and respond. The assistant treats reopened issues the same way as new issues - it evaluates its confidence level and will only post a public response if it meets the confidence threshold.

Trigger 3: When the assistant is tagged

Additionally, tagging the assistant will generate a response regardless of confidence level or whether public responses is enabled. To tag the assistant, simply respond to an issue or discussion with a comment that includes @inkeep or @inkeep-ai-assistant.