Home Getting Started
🚀

Getting Started

By Myra Magpantay
• 3 articles

Start guide on using Optimal AI

Optimal AI helps engineering teams by building AI agents that review code and track productivity to help developers ship faster, catch problems earlier, and build at hyperspeed. From Agentic code reviews with Optibot agents to real-time engineering productivity analytics with Insights, our platform adapts to your workflow and scales with your organization. This guide will walk you through the key features of Optimal AI and help you get set up quickly so your team can deliver secure, high-quality software with confidence. Let’s get started! Book a Personalized Walkthrough Book a demo to learn the essentials of Optibot and Insights. Our product team will walk you through core workflows, from installation to real-world use cases. Optimal AI Learning Library Our YouTube channel is the best place to stay up to date with Optimal AI. You’ll find: - Customer stories and best practices 🔔 Pro tip: Every time we release a new feature, we post a demo video on YouTube so you can see it in action right away. Setting up Optimal AI for your organization Once you’ve explored the basics, it’s time to bring Optimal AI into your workflow. The best way to start is by installing the Optibot agents in GitHub or GitLab using your work email (takes less than 2 minutes). Once installed, check out our onboarding guides: - Github Integration - Jira Integration - Slack Integration Other resources Examples of using Optimal AI See how other teams use Optimal AI in production: - How Prado scaled with Optibot link - Why Artemis Ops uses Optimal AI for compliance automation link - Engineering Productivity with Insights ✨ With Optimal AI, you’re empowering your team to code faster, review smarter, and ship securel

Last updated on Oct 20, 2025

Setting up your trial in Optimal AI | Step by Step Onboarding (Optibot + Insights)

Table of Contents 1. What “Activated” Looks Like 2. Prerequisites 3. Step-by-Step Onboarding (15–25 minutes) 4. First “Aha” Moments (what to check, when) 5. Quick Wins to Try This Week 6. Troubleshooting & Gotchas 7. FAQ 8. Need Help? 1) What “Activated” Looks Like You’re activated when: - Optibot installed on 1–2 active repos (fresh PRs are getting reviewed) - Insights connected to GitHub + Jira - Members added in Insights (so their metrics show) - Slack set up: shared support channel + notifications channel - You’ve seen Allocations → Distributions populate and one Optibot inline review + Slack ping (if your team is currently using Slack) 2) Prerequisites - GitHub org admin permissions - Jira admin (ability to create a service account or API token if you use Jira) - Slack permissions to install apps / create channels 3) Step-by-Step Onboarding (15–25 minutes) Step 1 — Install Optibot (GitHub App) 1. Open your Optibot install link (click here to access). 2. Choose your GitHub org → select 1–2 core repos (you can add more later). 3. Authorize and continue to the Optibot Dashboard. Tip: Pick repos with daily PR activity for fastest feedback. Step 2 — Create your Insights account (analytics) 1. Open the Insights Sign Up link. 2. Sign up with GitHub (not Sign In, on first run). 3. When asked which repos to monitor, select All or the set with active commits/PRs. Optibot and Insights can run independently, but together you’ll see agent impact + metrics side-by-side. Step 3 — Connect Slack (two parts) A. Shared Support Channel (with Optimal AI) Accept the invite from our team. This is your fastest path to help during trial. If you have not received an invite to slack, please email [email protected] to get you the invites. B. Optibot Notifications In Optibot → Connect Slack → pick or create a channel (e.g., #optibot-reviews). You’ll get messages when Optibot posts reviews/summaries and other info about your codebase. Step 4 — Add Members in Insights (critical) Insights → **Settings → **Members → add the engineers you want in dashboards. If a person isn’t added, their metrics won’t appear.. Step 5 — (Optional) Set up Teams in Insights - If you already use GitHub Teams, ping us to import them. - Or create teams in Insights and assign members for team-level views (Activity, PR Cycle Time by team). Step 6 — (Optional) Connect Jira to Insights If your team is a Jira user, follow these steps: 1. In Jira: Profile → Account Settings → Security → API tokens → create token. Prefer a service account (long-lived token; fewer expirations). 2. In Insights → Settings → Integrations** → Jira**: - Jira email (service/service-user or your email) - API token - Import users from Jira - Automatically integrate with Jira webhooks (if permissions allow) Jira email (service/service-user or your email) - Save. Notes: - Jira backfills historical data. - GitHub metrics populate from connection time forward (allow 24–48h for most views). Step 7 — (Optional) Connect Jira to Optibot Optibot → Integrations** → Jira** → reuse the same service account + token. Best practice: Include Jira ticket ID in branch names or PR titles (e.g., feat/ECOM-123-checkout). Step 8 — Validate Events & Notifications - Open/merge a small PR on a connected repo. - Confirm Optibot leaves an inline review + summary in GitHub. - Confirm a Slack notification appears. After Setup: 6) First Steps to Take in Platform Here are some things to play around with after set up: - **Insights → Investments → **Distributions See the mix of work across GitHub/Jira (bugs, hotfixes, features, dependencies, etc.). Within 24–48 Hours - PR Cycle Time — will populate as new PRs flow post-install. - Activity — becomes meaningful as members/teams are set. 7) Quick Wins to Try This Week 1. Set one guardrail Goal - Example: “Bugs ≤ 40% of work” or “Median PR size ≤ 300 LOC” - Insights → Goals → create threshold → attach to team/project. 2. Tune Review Flow with Optibot - Have Optibot review 3 fresh PRs. - Reply to its inline comments in GitHub (it supports back-and-forth conversation). - Use Slack notifs to keep reviewers unblocked. 3. Invite your VP Eng / Staff Eng to Insights - Add them in **Settings → **Members. 8) Troubleshooting & Gotchas - I don’t see metrics for someone. Add them in **Insights → Settings → **Members. (No member = no metrics.) - Teams are empty. Create teams in Insights or ask us to import from GitHub. - Slack isn’t posting. Re-connect Optibot → Slack and re-select the correct channel. - Jira data looks off / missing. Ensure GitHub + Jira profiles map to the same emails (or link Jira profiles in Insights). Prefer a service account token to avoid expiry. - PR views are empty. New PRs only populate PR Cycle Time; give it 24–48h after install. 9) FAQ Q: Do Optibot and Insights require each other? A: No. They work independently. Using both shows agent impact alongside team metrics. Q: Can you import GitHub Teams automatically? A: Yes, ask us in Slack; we’ll assist with import so team views populate. Q: How far back does data go? A: Jira backfills historical data. GitHub events count from the time of connection forward. Q: What’s the fastest path to value? A: Install Optibot on an active repo, add members in Insights, connect Slack, then open one small PR. Need Help? - Post in the shared Slack channel (fastest). - We also schedule a 30-min check-in mid way through the trial to review your data and set the right goals making sure you're gaining the most value. Screenshot Checklist - Insights Home with GitHub/Jira connected badges - Optibot → Install GitHub App (org/repo selector) - Insights → Sign Up (highlight “Sign up”) + Repo selection - Optibot → Slack integration (workspace + channel) - Insights → Settings → Members (add flow) - Insights → Teams (create/import) - Insights → Integrations → Jira (email/token + 2 checkboxes) - Optibot → Integrations → Jira (fields + save) - GitHub PR with Optibot inline comments (blur code) Slack notification from Optibot - Insights → Investments → Distributions (legend + % mix) - Insights → PR Cycle Time (median/time-in-stage) - Insights → Goals (create goal modal)

Last updated on Oct 20, 2025

GitHub App Installation & Troubleshooting Guide - Optibot / Optimal Insights

Overview Before Optibot can review pull requests or measure engineering productivity, it needs permission to connect to your organization’s repositories via the Optibot & Optimal Insights GitHub App. This guide explains: - How to install the Optibot and Optimal Insights GitHub App - How to confirm they’re installed correctly - How to re-request the installation email if it’s missing - How to troubleshoot common setup issues You can install Optibot and Insights on multiple accounts (personal and organization). Each installation controls which repositories the app can access. Installation Flow 1. Open the installation link Optibot (Code Reviewer): https://github.com/apps/agent-optibot/installations/new Optimal Insights: https://github.com/apps/optimal-insights/installations/new 2. Choose where to install Select your organization or your personal account. 3. Select repository access - All repositories (recommended) - or Only selected repositories (manually choose repos) 4. Review requested permissions Confirm you’re comfortable granting access to read/write PRs, commits, and metadata. 5. Click Install or Request - Install → you have permission to complete it. - Request → only org owners can approve. GitHub will email them automatically. When you authorize a GitHub App, you’re granting it permission to act on behalf of your GitHub user (e.g. to write comments). 🟡 Note: Installation ≠ Authorization. Both may be required depending on org settings. Who Can Install the App - Organization Owner Can install Optibot across the entire org and grant repo access. - Repo Admin Can install Optibot only on repos you administer (if no org-level permissions required). - Org Member (no admin rights) Can request installation — GitHub will email the org owner for approval. If you see a “Request” button instead of “Install,” it means the organization owner must approve the installation. How to Verify Installation A. Organization Level 1. Go to GitHub → Organization Settings → Third-party Access → GitHub Apps 2. Confirm Agent Optibot and Optimal Insights appears in the list. 3. Click Configure to view: - Permissions granted - Repositories connected - Option to suspend/remove B. Repository Level 1. Go to Repo → Settings → Integrations → GitHub Apps 2. Confirm Optibot & Optimal Insights is listed. 3. Check if it has access to the correct repo(s). Didn’t Receive the Installation Email? If GitHub didn’t send (or you can’t find) the installation email: 1. Check spam/junk folders 2. Confirm you have org owner privileges — only owners receive approval emails 3. Visit Settings → Installed GitHub Apps to check if Optibot already appears 4. If not, visit the install URL again and reinstall manually. 👉 GitHub Official Guide – Installing a GitHub App from a third party 👉 Optimal Insights Signup 👉 Optibot (Code Review) Signup  5. Still blocked? Have your org owner follow the same link to approve directly Common Issues Troubleshooting Checklist Before activation calls, confirm all boxes are checked: - Org owner accepted the install invite - Optibot appears under “Installed GitHub Apps” - Correct repositories are selected - Permissions include read/write on PRs and metadata - App installed at org or repo level (not just personal) - Team knows who to contact if re-request needed If any of these are missing, share this doc and resolve before the call. Quick Reference Links - Installing a GitHub App (Official) - Viewing Installed Apps - Requesting App Installation from Org Owner - Dockstore GitHub Apps Troubleshooting Reference

Last updated on Oct 29, 2025