User Guide

Everything you need to run TrimCI

Nine short chapters take you from first sign-up to board-ready PDF reports. Each chapter pairs step-by-step instructions with an animated walkthrough of the screens you will see, so you always know what comes next.

Chapter 1

Getting started

Create your account, verify your email, and set up your organization — every new workspace starts on a full-featured free trial.

Chapter 2

Connect GitHub Actions

Install the TrimCI GitHub App with read-only permissions, choose the repositories to track, and let the backfill collect your run history.

Chapter 3

Connect GitLab CI

Connect gitlab.com with OAuth or a self-hosted GitLab instance with an access token — zero code access either way.

Chapter 4

Connect GitLab behind a VPN

Run the open-source TrimCI Agent inside your network to analyze a self-hosted GitLab that trimci.com cannot reach — outbound only, your GitLab token never leaves your infrastructure.

Chapter 5

Reading the dashboard

Understand estimated loss, failure rate, the failure calendar, and the per-repository breakdowns — and how to switch the analysis window.

Chapter 6

PDF reports

Generate board-ready PDF reports: pick a window and repositories, preview in the browser, and tune SLO targets and cost rates.

Chapter 7

AI recommendations

Generate AI fix recommendations from failed-job logs, give feedback on what helped, and let spike detection watch for sudden regressions.

Chapter 8

Team & organizations

Invite teammates, assign roles, switch between organizations, and understand what owners, admins, and members can do.

Chapter 9

Plans & billing

Understand active-contributor billing, review who counts as billable, exclude bot accounts, and manage your subscription.

Chapter 10

Troubleshooting & FAQ

Answers to the most common questions: empty dashboards, sync cadence, suspended connections, and how long data is kept.