Getting Started

Your first CI run tracked in 5 minutes

Four steps. No YAML changes. No code instrumentation. Just connect your GitHub org and EmitCI tracks every run automatically.

⏱ Setup time~2 min
⚡ First data~30 sec after first run
🔧 Code changesNone required
1

Sign up with GitHub

You do: Click 'Continue with GitHub'You see: You land on your EmitCI dashboard

Go to app.emitci.com and click Continue with GitHub. EmitCI uses GitHub OAuth — no separate password or account creation needed.

app.emitci.com/login
EmitCI login page
Sign in with GitHub — one click, no separate account needed.

Tip

You'll land on the onboarding page after your first login. The next step happens there.

2

Install the GitHub App

You do: Select your org + repos on GitHub, click InstallYou see: Your repositories appear on the EmitCI dashboard

On the onboarding screen, click Install GitHub App. GitHub redirects you to a permissions screen where you:

  1. 1Select the GitHub organisation to install EmitCI on
  2. 2Choose which repositories to grant access to (All repos or specific ones)
  3. 3Click Install & Authorize

After installing, GitHub redirects you back to EmitCI. Your repositories immediately appear on the dashboard — no further setup needed.

app.emitci.com/dashboard
EmitCI dashboard showing connected repositories sorted by energy
After install — your repositories appear on the dashboard, sorted by carbon impact.

Tip

You must be an Owner of the GitHub organisation to install the app. If you're not, ask an owner to install it — you'll be added automatically.

3

Trigger any GitHub Actions workflow

You do: Push code, open a PR, or re-run an existing workflowYou see: EmitCI receives the run and begins processing

EmitCI listens for GitHub webhook events automatically — there's nothing to configure. Just run a workflow the way you normally would:

FastestGo to your repo on GitHub → Actions tab → pick any recent run → Re-run all jobs
Most commonPush a commit to any branch
Also worksOpen or update a pull request, or trigger a workflow_dispatch

EmitCI receives a webhook from GitHub the moment the workflow completes and starts processing immediately.

4

See your carbon data

You do: Wait ~30 seconds after workflow completesYou see: CO₂, energy, cost, and job breakdown appear on your dashboard

Within 30 seconds of your workflow completing, your dashboard shows:

🌿

CO₂ emitted

grams per run, per job, per step

⚡

Energy used

kWh calculated from runner hardware + region

💰

Compute cost

estimated cost of the runner time

📊

Recommendations

ranked actions to cut carbon and cost

app.emitci.com/repo/…
Repo detail page showing carbon data per run
Click any repository to see per-run carbon breakdown — energy, cost, jobs, and recommendations.
app.emitci.com/dashboard
Full EmitCI dashboard with carbon trends and repo list
The main dashboard — carbon trends over time, all repos ranked by impact, and anomaly alerts.

Setup complete

Every CI run from here is tracked automatically. No further setup needed for the core product.

Go to dashboard →

Optional — recommended next steps

These aren't required, but they make EmitCI significantly more useful.

○

Add your email address

Without an email on file, EmitCI can't send you anomaly alerts, weekly digests, or trial reminders. Add one at:

Go toSettings → Account → Contact Email
app.emitci.com/settings?tab=account
Settings Account tab showing the contact email field
Settings → Account — the orange banner appears when no email is on file.
○

Set a carbon budget

A carbon budget is a monthly CO₂ limit per repository. When a run pushes a repo over the threshold, EmitCI alerts you immediately. Start with your current 30-day total (shown on the dashboard under each repo) and reduce it by 10%.

Go toSettings → Budgets → select a repo → enter a monthly kg CO₂e limit
app.emitci.com/settings?tab=budgets
Settings Budgets tab
Settings → Budgets — set a monthly CO₂ cap per repository.
○

Invite your team

Add engineers, managers, or auditors so they can view the dashboard and reports without needing to be the GitHub App installer.

Go toSettings → Members → enter GitHub username → assign role
AdminFull access — billing, settings, data deletion
ManagerView all data, manage budgets and targets, download reports
MemberRead-only access to dashboard, insights, and exports
app.emitci.com/settings?tab=members
Settings Members tab
Settings → Members — invite teammates and assign roles.

Need help?

Read the full docs or check the FAQ. For anything else, email us.