Enhance installation process and logging for Copilot CLI status line feature

Author: devartifex

README.md

@@ -32,7 +32,7 @@ copilot-cost install
 
 Then **restart your shell and restart `copilot`**. That's it.
 
-The installer configures the Copilot CLI statusline, appends an idempotent OpenTelemetry block to your shell profile, and enables local JSONL span output under `~/.copilot/otel/`. It does **not** start the dashboard.
+The installer configures the Copilot CLI statusline (including the required `"experimental": true` flag in `~/.copilot/settings.json` — the GitHub Copilot CLI gates custom status lines behind that flag), appends an idempotent OpenTelemetry block to your shell profile, and enables local JSONL span output under `~/.copilot/otel/`. It does **not** start the dashboard.
 
 Prefer to edit your shell profile yourself? Run `copilot-cost install --no-otel-profile` — the OpenTelemetry block is printed for manual setup.
 
@@ -142,7 +142,7 @@ More on the underlying telemetry pipeline: [Copilot OpenTelemetry observability]
 
 ## 🩺 Troubleshooting
 
-- **The statusline does not appear.** Run `copilot-cost doctor`, then confirm the Copilot CLI was restarted after install.
+- **The statusline does not appear.** Run `copilot-cost doctor`. The custom statusline requires `"experimental": true` in `~/.copilot/settings.json` — without it the GitHub Copilot CLI ignores the `statusLine` block entirely (its logs show `STATUS_LINE: false`). Re-running `copilot-cost install` sets both keys; then restart Copilot CLI.
 - **No usage shows up yet.** Make sure you're on the latest Copilot CLI, restart your shell and `copilot`, send a prompt, then check for JSONL files in `~/.copilot/otel/`.
 - **I do not want profile edits.** Use `copilot-cost install --no-otel-profile` and paste the printed OpenTelemetry block into the shell profile you choose.
 - **The dashboard will not bind.** Use a local host only, e.g. `copilot-cost dashboard --host 127.0.0.1 --port 4567`.

package-lock.json

@@ -45,6 +45,36 @@ function otelDir(home = currentHome()): string {
   return path.join(home, ".copilot", "otel");
 }
 
+function copilotLogsDir(home = currentHome()): string {
+  return path.join(home, ".copilot", "logs");
+}
+
+export type StatusLineFlag = "enabled" | "disabled" | "unknown";
+
+export function detectStatusLineFeatureFlag(home = currentHome()): { state: StatusLineFlag; logFile?: string } {
+  const dir = copilotLogsDir(home);
+  if (!existsSync(dir)) return { state: "unknown" };
+  const candidates = readdirSync(dir)
+    .filter((name) => name.startsWith("process-") && name.endsWith(".log"))
+    .map((name) => ({ name, path: path.join(dir, name), mtimeMs: statSync(path.join(dir, name)).mtimeMs }))
+    .sort((a, b) => b.mtimeMs - a.mtimeMs);
+  for (const candidate of candidates.slice(0, 3)) {
+    let content: string;
+    try {
+      content = readFileSync(candidate.path, "utf-8");
+    } catch {
+      continue;
+    }
+    const matches = content.match(/"STATUS_LINE"\s*:\s*"(true|false)"/g);
+    if (!matches || matches.length === 0) continue;
+    const last = matches[matches.length - 1] ?? "";
+    const value = last.match(/"(true|false)"/)?.[1];
+    if (value === "true") return { state: "enabled", logFile: candidate.path };
+    if (value === "false") return { state: "disabled", logFile: candidate.path };
+  }
+  return { state: "unknown" };
+}
+
 function otelExporterPath(home = currentHome()): string {
   return path.join(otelDir(home), "copilot-otel.jsonl");
 }
@@ -164,11 +194,14 @@ function installSettings(settingsPath: string, shimPath: string): "updated" | "a
   mkdirSync(path.dirname(settingsPath), { recursive: true });
   const settings = readJsonObject(settingsPath);
   const next = { type: "command", command: shimPath, padding: 1 };
-  if (JSON.stringify(settings.statusLine ?? null) === JSON.stringify(next)) return "already-configured";
+  const statusLineMatches = JSON.stringify(settings.statusLine ?? null) === JSON.stringify(next);
+  const experimentalEnabled = settings.experimental === true;
+  if (statusLineMatches && experimentalEnabled) return "already-configured";
   if (existsSync(settingsPath)) {
     copyFileSync(settingsPath, `${settingsPath}.bak.${timestamp()}`);
   }
   settings.statusLine = next;
+  settings.experimental = true;
   writeFileSync(settingsPath, `${JSON.stringify(settings, null, 2)}\n`, "utf-8");
   return "updated";
 }
@@ -193,7 +226,7 @@ export async function cmdInstall(opts: { yes?: boolean; otelProfile?: boolean }
   console.log([
     "copilot-cost installed:",
     `  shim: ${paths.shimPath}`,
-    `  settings: ${paths.settingsPath} (${settingsAction})`,
+    `  settings: ${paths.settingsPath} (${settingsAction}; statusLine + experimental: true)`,
     `  shell profile: ${paths.profilePath}`,
     "  restart: restart Copilot CLI or open a new shell for OTel env vars",
     `  otel env: ${otelAction}`,
@@ -255,6 +288,8 @@ export async function cmdDoctor(): Promise<number> {
   const settings = existsSync(paths.settingsPath) ? readJsonObject(paths.settingsPath) : null;
   const statusLine = settings?.statusLine as { command?: unknown } | undefined;
   if (!okLine("settings statusLine", Boolean(settings && statusLine?.command === paths.shimPath), `${paths.settingsPath}; expected command ${paths.shimPath}`)) failed = true;
+  const experimentalEnabled = settings?.experimental === true;
+  if (!okLine("settings experimental", experimentalEnabled, experimentalEnabled ? `${paths.settingsPath} has \"experimental\": true (required for custom statusLine)` : `${paths.settingsPath} is missing \"experimental\": true; the Copilot CLI ignores statusLine without it. Re-run 'copilot-cost install' or set it manually.`)) failed = true;
 
   try {
     const pricing = loadPricing(pricingCachePath(paths.home));
@@ -273,6 +308,22 @@ export async function cmdDoctor(): Promise<number> {
   okLine("otel profile block", profileConfigured, profileConfigured ? paths.profilePath : `${paths.profilePath} missing copilot-cost block; run copilot-cost install`, false);
   const envEnabled = process.env.COPILOT_OTEL_ENABLED === "true" && process.env.COPILOT_OTEL_EXPORTER_TYPE === "file" && Boolean(process.env.COPILOT_OTEL_FILE_EXPORTER_PATH);
   okLine("shell restart", envEnabled, envEnabled ? "current shell has COPILOT_OTEL_* file exporter variables" : "restart your shell and Copilot CLI so COPILOT_OTEL_* variables take effect", false);
+  const statusLineFlag = detectStatusLineFeatureFlag(paths.home);
+  if (statusLineFlag.state === "disabled") {
+    okLine(
+      "copilot statusline feature",
+      false,
+      `Copilot CLI feature flag STATUS_LINE=false in ${statusLineFlag.logFile ?? copilotLogsDir(paths.home)}. The CLI gates the custom statusLine behind \"experimental\": true in ${paths.settingsPath}. Ensure that flag is set, then restart Copilot CLI.`,
+      false,
+    );
+  } else {
+    okLine(
+      "copilot statusline feature",
+      true,
+      statusLineFlag.state === "enabled" ? "Copilot CLI feature flag STATUS_LINE=true" : "Copilot CLI feature flag STATUS_LINE not observed yet; start Copilot CLI once to populate logs",
+      false,
+    );
+  }
   const otelPath = otelDir(paths.home);
   const jsonlCount = existsSync(otelPath) ? readdirSync(otelPath).filter((name) => name.endsWith(".jsonl") && name !== "copilot-cost-meta.jsonl").length : 0;
   okLine("otel jsonl files", jsonlCount > 0, `${otelPath} (${jsonlCount}); if zero, send a Copilot CLI prompt after shell restart`, false);

src/install.ts

@@ -38,6 +38,7 @@ describe("doctor", () => {
     await cmdInstall({ yes: true });
     await expect(cmdDoctor()).resolves.toBe(0);
     expect(logs.join("\n")).toContain("OK: settings statusLine");
+    expect(logs.join("\n")).toContain("OK: settings experimental");
     expect(logs.join("\n")).toContain("OK: pricing");
     expect(logs.join("\n")).toContain("OK: pricing cache");
     expect(logs.join("\n")).toContain("WARN: shell restart");
@@ -52,6 +53,7 @@ describe("doctor", () => {
     const { cmdDoctor } = await loadInstall("missing");
     await expect(cmdDoctor()).resolves.toBe(1);
     expect(logs.join("\n")).toContain("FAIL: settings statusLine");
+    expect(logs.join("\n")).toContain("FAIL: settings experimental");
     expect(logs.join("\n")).toContain("FAIL: shim executable");
     expect(logs.join("\n")).toContain("missing copilot-cost block");
   });
@@ -67,4 +69,31 @@ describe("doctor", () => {
     expect(logs.join("\n")).toContain("WARN: otel jsonl files");
     expect(logs.join("\n")).toContain("send a Copilot CLI prompt after shell restart");
   });
+
+  it("warns when Copilot CLI feature flag STATUS_LINE is false", async () => {
+    const logs: string[] = [];
+    vi.spyOn(console, "log").mockImplementation((msg?: unknown) => { logs.push(String(msg)); });
+    vi.spyOn(console, "error").mockImplementation(() => undefined);
+    const { cmdInstall, cmdDoctor } = await loadInstall("statusline-flag-off");
+    await cmdInstall({ yes: true });
+    const logsDir = path.join(root, "statusline-flag-off", ".copilot", "logs");
+    mkdirSync(logsDir, { recursive: true });
+    writeFileSync(path.join(logsDir, "process-1.log"), '{\n  "feature_flags": {\n    "STATUS_LINE": "false"\n  }\n}\n', "utf-8");
+    await expect(cmdDoctor()).resolves.toBe(0);
+    expect(logs.join("\n")).toContain("WARN: copilot statusline feature");
+    expect(logs.join("\n")).toContain("STATUS_LINE=false");
+  });
+
+  it("reports OK when Copilot CLI feature flag STATUS_LINE is true", async () => {
+    const logs: string[] = [];
+    vi.spyOn(console, "log").mockImplementation((msg?: unknown) => { logs.push(String(msg)); });
+    vi.spyOn(console, "error").mockImplementation(() => undefined);
+    const { cmdInstall, cmdDoctor } = await loadInstall("statusline-flag-on");
+    await cmdInstall({ yes: true });
+    const logsDir = path.join(root, "statusline-flag-on", ".copilot", "logs");
+    mkdirSync(logsDir, { recursive: true });
+    writeFileSync(path.join(logsDir, "process-1.log"), '{\n  "feature_flags": {\n    "STATUS_LINE": "true"\n  }\n}\n', "utf-8");
+    await expect(cmdDoctor()).resolves.toBe(0);
+    expect(logs.join("\n")).toContain("OK: copilot statusline feature");
+  });
 });

tests-ts/doctor.test.ts

@@ -39,8 +39,9 @@ describe("install commands", () => {
     expect(existsSync(otelDir)).toBe(true);
     expect(existsSync(otelExporterPath)).toBe(true);
     if (process.platform !== "win32") expect(statSync(shim).mode & 0o111).not.toBe(0);
-    const settings = JSON.parse(readFileSync(settingsPath, "utf-8")) as { statusLine: { command: string } };
+    const settings = JSON.parse(readFileSync(settingsPath, "utf-8")) as { statusLine: { command: string }; experimental: boolean };
     expect(settings.statusLine.command).toBe(shim);
+    expect(settings.experimental).toBe(true);
     expect(readFileSync(profilePath, "utf-8")).toContain("copilot-cost OTel exporter");
 
     await expect(cmdInstall({ yes: true })).resolves.toBe(0);