Update README and statusline preview to reflect GitHub AI Credits (AIC) terminology; enhance model normalization and rendering logic for AIC in payloads

Author: devartifex

README.md

@@ -9,7 +9,7 @@
 
 > ⚠️ **Unofficial.** This is a community project and is **not affiliated with, endorsed by, or supported by GitHub**. It reads the OpenTelemetry traces the [GitHub Copilot CLI](https://docs.github.com/en/copilot/concepts/agents/copilot-cli/about-copilot-cli) already emits — nothing more.
 
-A zero-config **statusline + local dashboard** that turns Copilot CLI's OpenTelemetry traces into a real-time, model-aware view of your **token usage and estimated spend** — without your data ever leaving your machine.
+A zero-config **statusline + local dashboard** that turns Copilot CLI's OpenTelemetry traces into a real-time, model-aware view of your **token usage and estimated GitHub AI Credits (AIC)** — without your data ever leaving your machine.
 
 ![copilot-cost statusline in the GitHub Copilot CLI](docs/ghcpcli.png)
 
@@ -49,9 +49,9 @@ Three styles, controlled by `COPILOT_COST_FORMAT`:
 
 | Format | Aliases | Example |
 | --- | --- | --- |
-| `standard` | _default_ | `$1.2522 · 1.5M in / 7.9k out · 1.5M cache` |
-| `compact` | `minimal` | `$1.2522` |
-| `full` | `verbose` | `$1.2522 (125.22 aic) · 38.4k fresh / 1.4M cache rd / 62.1k cache wr / 7.9k out · Σ 1.5M · 1.6k reason` |
+| `standard` | _default_ | `125.22 AIC · 1.5M in / 7.9k out · 1.5M cache` |
+| `compact` | `minimal` | `125.22 AIC` |
+| `full` | `verbose` | `125.22 AIC ($1.2522) · 38.4k fresh / 1.4M cache rd / 62.1k cache wr / 7.9k out · Σ 1.5M · 1.6k reason` |
 
 ```bash
 export COPILOT_COST_FORMAT=compact
@@ -110,7 +110,7 @@ GitHub Copilot CLI ──OTel spans (JSONL)──▶ ~/.copilot/otel/copilot-ote
    export COPILOT_OTEL_FILE_EXPORTER_PATH="$HOME/.copilot/otel/copilot-otel.jsonl"
    ```
 2. **Aggregate** — on every render, recent spans are read, `gen_ai.usage.*` counters and `gen_ai.request.model` are extracted, and rolled up by session / model / day.
-3. **Price** — token counts are multiplied by a bundled pricing snapshot (refreshable from [Copilot models & pricing](https://docs.github.com/en/copilot/reference/copilot-billing/models-and-pricing)) to produce an **estimated** USD cost.
+3. **Price** — token counts are multiplied by a bundled pricing snapshot (refreshable from [Copilot models & pricing](https://docs.github.com/en/copilot/reference/copilot-billing/models-and-pricing)) to produce **estimated** GitHub AI Credits (AIC). The `full` statusline also shows the equivalent USD conversion.
 4. **Render** — a one-line statusline, plus an optional local web dashboard.
 
 More on the underlying telemetry pipeline: [Copilot OpenTelemetry observability](https://docs.github.com/en/copilot/how-tos/copilot-sdk/observability/opentelemetry).

docs/statusline-preview.txt

@@ -1,3 +1,3 @@
-standard: $1.2522 · 1.5M in / 7.9k out · 1.5M cache
-compact:  $1.2522
-full:     $1.2522 (125.22 aic) · 38.4k fresh / 1.4M cache rd / 62.1k cache wr / 7.9k out · Σ 1.5M · 1.6k reason
+standard: 125.22 AIC · 1.5M in / 7.9k out · 1.5M cache
+compact:  125.22 AIC
+full:     125.22 AIC ($1.2522) · 38.4k fresh / 1.4M cache rd / 62.1k cache wr / 7.9k out · Σ 1.5M · 1.6k reason

scripts/generate-demo-screenshots.mjs

@@ -102,9 +102,9 @@ function writeFixture() {
   const lines = syntheticSpans().map((span) => JSON.stringify(span));
   writeFileSync(fixturePath, `${lines.join("\n")}\n`);
   writeFileSync(statuslinePath, [
-    "standard: $1.2522 · 1.5M in / 7.9k out · 1.5M cache",
-    "compact:  $1.2522",
-    "full:     $1.2522 (125.22 aic) · 38.4k fresh / 1.4M cache rd / 62.1k cache wr / 7.9k out · Σ 1.5M · 1.6k reason",
+    "standard: 125.22 AIC · 1.5M in / 7.9k out · 1.5M cache",
+    "compact:  125.22 AIC",
+    "full:     125.22 AIC ($1.2522) · 38.4k fresh / 1.4M cache rd / 62.1k cache wr / 7.9k out · Σ 1.5M · 1.6k reason",
     "",
   ].join("\n"));
 }

src/pricing/loader.ts

@@ -42,12 +42,24 @@ const pricingCache = new Map<string, PricingCacheEntry>();
 export function normalizeModel(modelId: string | undefined | null): string | null {
   if (!modelId) return null;
   let model = String(modelId).trim();
+  const parentheticalModel = /^auto\b.*\(([^)]+)\)/i.exec(model);
+  if (parentheticalModel?.[1]) {
+    model = parentheticalModel[1];
+  }
+  model = model
+    .replace(/\[\^[^\]]+\]/g, "")
+    .trim()
+    .toLowerCase()
+    .replace(/[\s_]+/g, "-")
+    .replace(/[^a-z0-9.+-]+/g, "-")
+    .replace(/-+/g, "-")
+    .replace(/^-|-$/g, "");
   for (const suffix of ["-1m-internal", "-fast"]) {
     if (model.endsWith(suffix)) {
       model = model.slice(0, -suffix.length);
     }
   }
-  return model;
+  return model || null;
 }
 
 function parseYaml(text: string): RawPricing {

src/render.ts

@@ -14,6 +14,13 @@ function intValue(source: JsonObject, key: string): number {
   return Number.isFinite(n) ? Math.trunc(n) : 0;
 }
 
+function numValue(source: JsonObject, key: string): number | null {
+  const value = source[key];
+  if (value === undefined || value === null || value === "") return null;
+  const n = Number(value);
+  return Number.isFinite(n) ? n : null;
+}
+
 function strValue(source: JsonObject, key: string): string | null {
   const value = source[key];
   if (value === undefined || value === null || value === "") return null;
@@ -26,10 +33,57 @@ function short(n: number): string {
   return String(n);
 }
 
+function firstNumber(source: JsonObject, keys: string[]): number | null {
+  for (const key of keys) {
+    const value = numValue(source, key);
+    if (value !== null) return value;
+  }
+  return null;
+}
+
+function payloadAic(root: JsonObject): number | null {
+  const cost = asObject(root.cost);
+  return firstNumber(cost, [
+    "total_ai_credits",
+    "total_aic",
+    "ai_credits",
+    "aic",
+    "total_cost_ai_credits",
+  ]) ?? firstNumber(root, [
+    "total_ai_credits",
+    "total_aic",
+    "ai_credits",
+    "aic",
+  ]);
+}
+
+function formatAic(aic: number | null, model: string | null): string {
+  if (aic !== null) return `${aic.toFixed(2)} AIC`;
+  return model ? `? AIC (${model})` : "? AIC";
+}
+
+function modelCandidates(root: JsonObject): string[] {
+  const modelInfo = asObject(root.model);
+  const values = [
+    strValue(modelInfo, "id"),
+    strValue(modelInfo, "resolved_id"),
+    strValue(modelInfo, "selected_id"),
+    strValue(modelInfo, "selected_model"),
+    strValue(modelInfo, "display_name"),
+    strValue(modelInfo, "name"),
+    strValue(root, "model_id"),
+    strValue(root, "resolved_model"),
+    strValue(root, "selected_model"),
+  ];
+  return [...new Set(values.filter((value): value is string => value !== null))];
+}
+
 export function renderPayload(payload: unknown, opts: { persist?: boolean } = {}): string {
   const root = asObject(payload);
-  const modelInfo = asObject(root.model);
-  const rawModel = typeof modelInfo.id === "string" ? modelInfo.id : modelInfo.id == null ? undefined : String(modelInfo.id);
+  const candidates = modelCandidates(root);
+  const fallbackModel = candidates[0];
+  const pricedModel = candidates.map((candidate) => ({ raw: candidate, ...getModelPrice(candidate) })).find((candidate) => candidate.price);
+  const rawModel = pricedModel?.raw ?? fallbackModel;
   const cw = asObject(root.context_window);
   const totalInput = intValue(cw, "total_input_tokens");
   const output = intValue(cw, "total_output_tokens");
@@ -54,32 +108,35 @@ export function renderPayload(payload: unknown, opts: { persist?: boolean } = {}
     return "";
   }
 
-  const { model, price } = getModelPrice(rawModel);
-  let usd = 0;
+  const { price } = pricedModel ?? getModelPrice(rawModel);
+  let usd: number | null = 0;
   if (price) {
     usd = computeCost({ input: totalInput, cache_read: cacheRead, cache_write: cacheWrite, output }, price);
   } else if (!isEmpty) {
-    const shown = normalizeModel(rawModel) ?? "unknown";
-    return `$? (${shown})`;
+    usd = null;
   }
+  const explicitAic = payloadAic(root);
+  const aic = explicitAic ?? (usd === null ? null : usd * 100);
   const fmt = process.env.COPILOT_COST_FORMAT ?? "standard";
   const reasoning = intValue(cw, "total_reasoning_tokens");
   const fresh = Math.max(totalInput - cacheRead - cacheWrite, 0);
+  const shownModel = normalizeModel(rawModel) ?? (rawModel ? String(rawModel).trim() : null);
+  const aicText = formatAic(aic, usd === null ? shownModel : null);
+  const displayUsd = explicitAic === null ? usd : explicitAic / 100;
 
   let body: string;
   if (fmt === "compact" || fmt === "minimal") {
-    body = `$${usd.toFixed(4)}`;
+    body = aicText;
   } else if (fmt === "full" || fmt === "verbose") {
-    const credits = usd * 100;
     const parts = [
-      `$${usd.toFixed(4)} (${credits.toFixed(2)} aic)`,
+      displayUsd === null ? aicText : `${aicText} ($${displayUsd.toFixed(4)})`,
       `${short(fresh)} fresh / ${short(cacheRead)} cache rd / ${short(cacheWrite)} cache wr / ${short(output)} out`,
       `Σ ${short(totalInput + output)}`,
     ];
     if (reasoning) parts.push(`${short(reasoning)} reason`);
     body = parts.join(" · ");
   } else {
-    const parts = [`$${usd.toFixed(4)}`, `${short(totalInput)} in / ${short(output)} out`];
+    const parts = [aicText, `${short(totalInput)} in / ${short(output)} out`];
     if (cacheRead || cacheWrite) parts.push(`${short(cacheRead + cacheWrite)} cache`);
     body = parts.join(" · ");
   }

tests-ts/pricing.test.ts

@@ -77,6 +77,12 @@ describe("pricing loader", () => {
     expect(normalizeModel("gpt-5-mini-fast")).toBe("gpt-5-mini");
   });
 
+  it("normalizes display names and auto labels", () => {
+    expect(normalizeModel("Claude Opus 4.7")).toBe("claude-opus-4.7");
+    expect(normalizeModel("GPT-5 mini")).toBe("gpt-5-mini");
+    expect(normalizeModel("Auto (Claude Sonnet 4.6)")).toBe("claude-sonnet-4.6");
+  });
+
   it("computes cost using fresh, cache read, cache write, and output tokens", () => {
     const price = { vendor: "anthropic", input: 5, cached_input: 0.5, cache_write: 6.25, output: 25 };
     const cost = computeCost({ input: 38_200, cache_read: 12_000, cache_write: 3_100, output: 6_100 }, price);

tests-ts/render.test.ts

@@ -26,7 +26,8 @@ describe("renderPayload", () => {
   it("renders default standard format", () => {
     process.env.COPILOT_COST_NO_COLOR = "1";
     const output = renderPayload(payload, { persist: false });
-    expect(output).toContain("$");
+    expect(output).toContain("29.34 AIC");
+    expect(output).not.toContain("$");
     expect(output).toContain("38.2k in / 6.1k out");
   });
 
@@ -36,31 +37,90 @@ describe("renderPayload", () => {
     expect(existsSync(path.join(process.env.COPILOT_OTEL_DIR ?? "", "copilot-cost-meta.jsonl"))).toBe(false);
   });
 
-  it("renders a numeric amount for non-numeric token counts", () => {
+  it("renders a numeric AIC amount for non-numeric token counts", () => {
     process.env.COPILOT_COST_NO_COLOR = "1";
     const malformedPayload = JSON.parse(JSON.stringify(payload)) as { context_window: { total_input_tokens: string } };
     malformedPayload.context_window.total_input_tokens = "not-a-number";
 
     const output = renderPayload(malformedPayload, { persist: false });
 
-    expect(output).toMatch(/\$\d+\.\d{4}/);
+    expect(output).toMatch(/\d+\.\d{2} AIC/);
     expect(output).not.toContain("NaN");
   });
 
   it("renders compact format", () => {
     process.env.COPILOT_COST_NO_COLOR = "1";
     process.env.COPILOT_COST_FORMAT = "compact";
-    expect(renderPayload(payload, { persist: false })).toMatch(/^\$\d+\.\d{4}$/);
+    expect(renderPayload(payload, { persist: false })).toBe("29.34 AIC");
   });
 
   it("renders verbose format", () => {
     process.env.COPILOT_COST_NO_COLOR = "1";
     process.env.COPILOT_COST_FORMAT = "verbose";
     const output = renderPayload(payload, { persist: false });
+    expect(output).toContain("29.34 AIC ($0.2934)");
     expect(output).toContain("fresh / 12.0k cache rd / 3.1k cache wr / 6.1k out");
     expect(output).toContain("900 reason");
   });
 
+  it("uses explicit payload AI credits when provided", () => {
+    process.env.COPILOT_COST_NO_COLOR = "1";
+    const payloadWithCredits = JSON.parse(JSON.stringify(payload)) as { cost: { total_ai_credits: number } };
+    payloadWithCredits.cost.total_ai_credits = 12.345;
+
+    expect(renderPayload(payloadWithCredits, { persist: false })).toContain("12.35 AIC");
+  });
+
+  it("keeps rendering token usage when auto model pricing is unavailable", () => {
+    process.env.COPILOT_COST_NO_COLOR = "1";
+    const autoPayload = JSON.parse(JSON.stringify(payload)) as { model: { id: string; display_name: string } };
+    autoPayload.model.id = "auto";
+    autoPayload.model.display_name = "Auto";
+
+    const output = renderPayload(autoPayload, { persist: false });
+
+    expect(output).toContain("? AIC (auto)");
+    expect(output).toContain("38.2k in / 6.1k out");
+    expect(output).not.toContain("$?");
+  });
+
+  it.each([
+    ["standard", "29.34 AIC · 38.2k in / 6.1k out · 15.1k cache"],
+    ["compact", "29.34 AIC"],
+    ["full", "29.34 AIC ($0.2934) · 23.1k fresh / 12.0k cache rd / 3.1k cache wr / 6.1k out · Σ 44.3k · 900 reason"],
+  ])("prices auto model from display name in %s format", (format, expected) => {
+    process.env.COPILOT_COST_NO_COLOR = "1";
+    process.env.COPILOT_COST_FORMAT = format;
+    const autoPayload = JSON.parse(JSON.stringify(payload)) as { model: { id: string } };
+    autoPayload.model.id = "auto";
+
+    expect(renderPayload(autoPayload, { persist: false })).toBe(expected);
+  });
+
+  it.each([
+    ["standard", "? AIC (auto) · 38.2k in / 6.1k out · 15.1k cache"],
+    ["compact", "? AIC (auto)"],
+    ["full", "? AIC (auto) · 23.1k fresh / 12.0k cache rd / 3.1k cache wr / 6.1k out · Σ 44.3k · 900 reason"],
+  ])("renders auto model without pricing in %s format", (format, expected) => {
+    process.env.COPILOT_COST_NO_COLOR = "1";
+    process.env.COPILOT_COST_FORMAT = format;
+    const autoPayload = JSON.parse(JSON.stringify(payload)) as { model: { id: string; display_name: string } };
+    autoPayload.model.id = "auto";
+    autoPayload.model.display_name = "Auto";
+
+    expect(renderPayload(autoPayload, { persist: false })).toBe(expected);
+  });
+
+  it("converts explicit AI credits to dollars only in verbose format", () => {
+    process.env.COPILOT_COST_NO_COLOR = "1";
+    process.env.COPILOT_COST_FORMAT = "verbose";
+    const autoPayload = JSON.parse(JSON.stringify(payload)) as { model: { id: string }; cost: { total_ai_credits: number } };
+    autoPayload.model.id = "auto";
+    autoPayload.cost.total_ai_credits = 12.345;
+
+    expect(renderPayload(autoPayload, { persist: false })).toContain("12.35 AIC ($0.1235)");
+  });
+
   it("strips ANSI color when color is disabled", () => {
     process.env.COPILOT_COST_NO_COLOR = "1";
     const output = renderPayload(payload, { persist: false });
@@ -69,7 +129,7 @@ describe("renderPayload", () => {
 
   it("renders a zero placeholder by default when payload has no usage", () => {
     process.env.COPILOT_COST_NO_COLOR = "1";
-    expect(renderPayload({}, { persist: false })).toBe("$0.0000 · 0 in / 0 out");
+    expect(renderPayload({}, { persist: false })).toBe("0.00 AIC · 0 in / 0 out");
   });
 
   it("returns empty string when payload has no usage and COPILOT_COST_HIDE_ZERO is set", () => {
@@ -81,6 +141,6 @@ describe("renderPayload", () => {
   it("renders a zero placeholder in compact format by default", () => {
     process.env.COPILOT_COST_NO_COLOR = "1";
     process.env.COPILOT_COST_FORMAT = "compact";
-    expect(renderPayload({}, { persist: false })).toBe("$0.0000");
+    expect(renderPayload({}, { persist: false })).toBe("0.00 AIC");
   });
 });