feat: add TUI email masking (#160)

Opt-in TUI email masking via maskEmail/maskEmailInQuotaDetails config and CODEX_TUI_MASK_EMAIL/CODEX_TUI_MASK_EMAIL_DETAILS env vars. Masks account hints in prompt quota status and quota details; defaults false. Docs + tests + .gitignore reorg.

Author: hawkff

.gitignore

@@ -1,23 +1,79 @@
+# Dependencies
 node_modules/
 bun.lockb
 pnpm-lock.yaml
+
+# Environment / secrets
+.env
+.env.local
+credentials.json
+state.json
+
+# Build artifacts
 dist/
+build/
+*.tgz
+*.patched
+
+# macOS / Apple sidecar files
+._*
 .DS_Store
-.history/
+.AppleDouble
+.LSOverride
+
+# OpenCode local config and cache
 opencode.json
 .opencode/
-tmp
-tmp*
-*.tgz
-*.patched
-*first_fail*
-Heap-*.heapsnapshot
 .codex-cache
 .sisyphus/
-coverage/
-winston/
+
+# Skills
+.agents/
+skills-lock.json
+
+# IDE
+.history/
+.vscode/
+.idea/
+.shard/
+
+# Local Docker Compose overrides
+docker-compose.yaml
+docker-compose.local.yml
+docker-compose.local.yaml
+compose.local.yml
+compose.local.yaml
+
+# Temporary files
+tmp
+tmp*
 .tmp-plugin-test/
 .tmp-release-*.md
+
+# Debug logs
+debug_logs*/
+debug*.json
+winston/
+Heap-*.heapsnapshot
+*first_fail*
+
+# Project-specific notes and scratch files
+_notes/
+requests/
 task_plan.md
 findings.md
 progress.md
+
+# Testing and coverage
+coverage/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg-info/

README.md

@@ -249,6 +249,8 @@ Selected runtime/environment overrides:
 | `CODEX_TUI_V2=0/1` | Disable/enable codex-style tool output |
 | `CODEX_TUI_COLOR_PROFILE=truecolor|ansi256|ansi16` | Force terminal color profile |
 | `CODEX_TUI_GLYPHS=ascii|unicode|auto` | Force terminal glyph style |
+| `CODEX_TUI_MASK_EMAIL=0/1` | Hide account email in TUI quota status only |
+| `CODEX_TUI_MASK_EMAIL_DETAILS=0/1` | Also hide account email in quota details when prompt masking is enabled |
 | `CODEX_AUTH_PER_PROJECT_ACCOUNTS=0/1` | Disable/enable per-project account pools |
 | `CODEX_AUTH_AUTO_UPDATE=0/1` | Disable/enable daily npm update check and cache refresh |
 | `CODEX_AUTH_UNSUPPORTED_MODEL_POLICY=strict|fallback` | Control unsupported-model retry behavior |

docs/configuration.md

@@ -121,6 +121,8 @@ advanced settings go in `~/.opencode/openai-codex-auth-config.json`:
   "codexTuiV2": true,
   "codexTuiColorProfile": "truecolor",
   "codexTuiGlyphMode": "ascii",
+  "maskEmail": false,
+  "maskEmailInQuotaDetails": false,
   "beginnerSafeMode": false,
   "fastSession": false,
   "fastSessionStrategy": "hybrid",
@@ -157,6 +159,8 @@ The sample above intentionally sets `"retryAllAccountsMaxRetries": 3` as a bound
 | `codexTuiV2` | `true` | enables codex-style terminal ui output (set `false` to keep legacy output) |
 | `codexTuiColorProfile` | `truecolor` | terminal color profile for codex ui (`truecolor`, `ansi256`, `ansi16`) |
 | `codexTuiGlyphMode` | `ascii` | glyph set for codex ui (`ascii`, `unicode`, `auto`) |
+| `maskEmail` | `false` | masks the active account email in the TUI prompt quota status only |
+| `maskEmailInQuotaDetails` | `false` | also masks the active account email in the quota details dialog when `maskEmail` is enabled |
 | `beginnerSafeMode` | `false` | enables conservative beginner-safe runtime behavior for retries and recovery |
 | `fastSession` | `false` | forces low-latency settings per request (`reasoningEffort=none/low`, `reasoningSummary=auto`, `textVerbosity=low`) |
 | `fastSessionStrategy` | `hybrid` | `hybrid` speeds simple turns and keeps full-depth for complex prompts; `always` forces fast mode every turn |
@@ -241,6 +245,8 @@ override any config with env vars:
 | `CODEX_TUI_V2=0` | disable codex-style ui (use legacy output) |
 | `CODEX_TUI_COLOR_PROFILE=ansi16` | force color profile for codex ui |
 | `CODEX_TUI_GLYPHS=unicode` | override glyph mode (`ascii`, `unicode`, `auto`) |
+| `CODEX_TUI_MASK_EMAIL=1` | mask the active account email in the TUI prompt quota status only |
+| `CODEX_TUI_MASK_EMAIL_DETAILS=1` | also mask the active account email in quota details when prompt masking is enabled |
 | `CODEX_AUTH_PREWARM=0` | disable startup prewarm (prompt/instruction cache warmup) |
 | `CODEX_AUTH_FAST_SESSION=1` | enable fast-session defaults |
 | `CODEX_AUTH_FAST_SESSION_STRATEGY=always` | force fast mode on every prompt |

docs/development/TUI_PARITY_CHECKLIST.md

@@ -78,6 +78,7 @@ Use this checklist to keep `oc-codex-multi-auth` aligned with the Antigravity-st
 - Visual controls:
   - `codexTuiColorProfile`: `truecolor` / `ansi256` / `ansi16`
   - `codexTuiGlyphMode`: `ascii` / `unicode` / `auto`
+- Privacy controls: `maskEmail: true` or `CODEX_TUI_MASK_EMAIL=1` hides account email in prompt quota status only; `maskEmailInQuotaDetails: true` or `CODEX_TUI_MASK_EMAIL_DETAILS=1` extends masking to quota details.
 
 ## Tooling Parity
 

lib/config.ts

@@ -35,6 +35,8 @@ const DEFAULT_CONFIG: PluginConfig = {
 	codexTuiV2: true,
 	codexTuiColorProfile: "truecolor",
 	codexTuiGlyphMode: "ascii",
+	maskEmail: false,
+	maskEmailInQuotaDetails: false,
 	beginnerSafeMode: false,
 	fastSession: false,
 	fastSessionStrategy: "hybrid",
@@ -283,6 +285,24 @@ export function getCodexTuiGlyphMode(
 	);
 }
 
+export function getCodexTuiMaskEmail(pluginConfig: PluginConfig): boolean {
+	return resolveBooleanSetting(
+		"CODEX_TUI_MASK_EMAIL",
+		pluginConfig.maskEmail,
+		false,
+	);
+}
+
+export function getCodexTuiMaskEmailInQuotaDetails(
+	pluginConfig: PluginConfig,
+): boolean {
+	return resolveBooleanSetting(
+		"CODEX_TUI_MASK_EMAIL_DETAILS",
+		pluginConfig.maskEmailInQuotaDetails,
+		false,
+	);
+}
+
 export function getFastSession(pluginConfig: PluginConfig): boolean {
 	return resolveBooleanSetting(
 		"CODEX_AUTH_FAST_SESSION",

lib/schemas.ts

@@ -16,6 +16,8 @@ export const PluginConfigSchema = z.object({
 	codexTuiV2: z.boolean().optional(),
 	codexTuiColorProfile: z.enum(["truecolor", "ansi16", "ansi256"]).optional(),
 	codexTuiGlyphMode: z.enum(["ascii", "unicode", "auto"]).optional(),
+	maskEmail: z.boolean().optional(),
+	maskEmailInQuotaDetails: z.boolean().optional(),
 	beginnerSafeMode: z.boolean().optional(),
 	fastSession: z.boolean().optional(),
 	fastSessionStrategy: z.enum(["hybrid", "always"]).optional(),

lib/tui-status.ts

@@ -56,6 +56,9 @@ const variantSuffixes: ReasoningVariant[] = [
 const STATUS_SEPARATOR = ` ${String.fromCharCode(183)} `;
 const WARNING_LIMIT_LEFT_PERCENT = 25;
 const DANGER_LIMIT_LEFT_PERCENT = 10;
+const MASKED_EMAIL = "*****";
+const EMAIL_PATTERN = /[^\s(),<>]+@[^\s(),<>]+/;
+const EMAIL_PATTERN_GLOBAL = /[^\s(),<>]+@[^\s(),<>]+/g;
 
 function isRecord(value: unknown): value is Record<string, unknown> {
 	return value !== null && typeof value === "object" && !Array.isArray(value);
@@ -190,13 +193,24 @@ function isPercent(value: number | null): value is number {
 }
 
 function extractEmailFromLabel(label: string | undefined): string | undefined {
-	const match = label?.match(/[^\s(),<>]+@[^\s(),<>]+/);
+	const match = label?.match(EMAIL_PATTERN);
 	return match?.[0];
 }
 
-function formatAccountEmail(email: string | undefined): string | undefined {
+function formatAccountEmail(
+	email: string | undefined,
+	maskEmail: boolean,
+): string | undefined {
 	const trimmed = email?.trim() || undefined;
-	return trimmed ? `[${trimmed}]` : undefined;
+	return trimmed ? `[${maskEmail ? MASKED_EMAIL : trimmed}]` : undefined;
+}
+
+function maskEmailsInText(
+	value: string | undefined,
+	maskEmail: boolean,
+): string | undefined {
+	if (!value) return undefined;
+	return maskEmail ? value.replace(EMAIL_PATTERN_GLOBAL, MASKED_EMAIL) : value;
 }
 
 function formatQuotaLimit(
@@ -212,7 +226,10 @@ function formatQuotaLimit(
 	return reset ? `${base} resets ${reset}` : base;
 }
 
-function formatAccountHint(quota: CompactQuotaStatus): string | undefined {
+function formatAccountHint(
+	quota: CompactQuotaStatus,
+	maskEmail = false,
+): string | undefined {
 	if (quota.type !== "ready") return undefined;
 	if (
 		typeof quota.accountIndex !== "number" ||
@@ -228,8 +245,8 @@ function formatAccountHint(quota: CompactQuotaStatus): string | undefined {
 		return undefined;
 	}
 	const email =
-		formatAccountEmail(quota.accountEmail) ??
-		formatAccountEmail(extractEmailFromLabel(quota.accountLabel));
+		formatAccountEmail(quota.accountEmail, maskEmail) ??
+		formatAccountEmail(extractEmailFromLabel(quota.accountLabel), maskEmail);
 	if (email) return email;
 	return `A${quota.accountIndex}`;
 }
@@ -286,9 +303,10 @@ export function formatPromptStatusText(params: {
 	variant?: ReasoningVariant;
 	quota: CompactQuotaStatus;
 	width?: number;
+	maskEmail?: boolean;
 }): string {
 	const variant = params.variant;
-	const account = formatAccountHint(params.quota);
+	const account = formatAccountHint(params.quota, params.maskEmail);
 	const quotaParts = formatQuotaParts(params.quota, true);
 	const quotaPartsWithoutReset = formatQuotaParts(params.quota, false);
 	const quota = quotaParts.length > 0
@@ -403,17 +421,19 @@ function formatDetailsLimit(limit: CompactQuotaLimit): string {
 export function formatQuotaDetailsText(
 	quota: CompactQuotaStatus,
 	now = Date.now(),
+	options: { maskEmail?: boolean } = {},
 ): string {
 	if (quota.type === "loading") return "Quota is loading.";
 	if (quota.type === "missing") return "No Codex OAuth account is configured.";
 	if (quota.type === "unavailable") return "Quota is unavailable.";
 
 	const lines: string[] = [];
-	const accountHint = formatAccountHint(quota);
-	if (quota.accountLabel && accountHint) {
-		lines.push(`Account: ${accountHint} (${quota.accountLabel})`);
-	} else if (quota.accountLabel) {
-		lines.push(`Account: ${quota.accountLabel}`);
+	const accountHint = formatAccountHint(quota, options.maskEmail);
+	const accountLabel = maskEmailsInText(quota.accountLabel, Boolean(options.maskEmail));
+	if (accountLabel && accountHint) {
+		lines.push(`Account: ${accountHint} (${accountLabel})`);
+	} else if (accountLabel) {
+		lines.push(`Account: ${accountLabel}`);
 	} else if (accountHint) {
 		lines.push(`Account: ${accountHint}`);
 	}

test/plugin-config.test.ts

@@ -5,6 +5,8 @@ import {
 	getCodexTuiV2,
 	getCodexTuiColorProfile,
 	getCodexTuiGlyphMode,
+	getCodexTuiMaskEmail,
+	getCodexTuiMaskEmailInQuotaDetails,
 	getBeginnerSafeMode,
 	getFastSession,
 	getFastSessionStrategy,
@@ -55,6 +57,8 @@ describe('Plugin Configuration', () => {
 		'CODEX_TUI_V2',
 		'CODEX_TUI_COLOR_PROFILE',
 		'CODEX_TUI_GLYPHS',
+		'CODEX_TUI_MASK_EMAIL',
+		'CODEX_TUI_MASK_EMAIL_DETAILS',
 		'CODEX_AUTH_FAST_SESSION',
 		'CODEX_AUTH_BEGINNER_SAFE_MODE',
 		'CODEX_AUTH_FAST_SESSION_STRATEGY',
@@ -98,6 +102,8 @@ describe('Plugin Configuration', () => {
 				codexTuiV2: true,
 				codexTuiColorProfile: 'truecolor',
 				codexTuiGlyphMode: 'ascii',
+				maskEmail: false,
+				maskEmailInQuotaDetails: false,
 				beginnerSafeMode: false,
 				fastSession: false,
 				fastSessionStrategy: 'hybrid',
@@ -143,6 +149,8 @@ describe('Plugin Configuration', () => {
 				codexTuiV2: true,
 				codexTuiColorProfile: 'truecolor',
 				codexTuiGlyphMode: 'ascii',
+				maskEmail: false,
+				maskEmailInQuotaDetails: false,
 				beginnerSafeMode: false,
 				fastSession: false,
 				fastSessionStrategy: 'hybrid',
@@ -185,6 +193,8 @@ describe('Plugin Configuration', () => {
 				codexTuiV2: true,
 				codexTuiColorProfile: 'truecolor',
 				codexTuiGlyphMode: 'ascii',
+				maskEmail: false,
+				maskEmailInQuotaDetails: false,
 				beginnerSafeMode: false,
 				fastSession: false,
 				fastSessionStrategy: 'hybrid',
@@ -238,6 +248,8 @@ describe('Plugin Configuration', () => {
 		codexTuiV2: true,
 		codexTuiColorProfile: 'truecolor',
 		codexTuiGlyphMode: 'ascii',
+		maskEmail: false,
+		maskEmailInQuotaDetails: false,
 		beginnerSafeMode: false,
 		fastSession: false,
 		fastSessionStrategy: 'hybrid',
@@ -285,6 +297,8 @@ describe('Plugin Configuration', () => {
 			codexTuiV2: true,
 			codexTuiColorProfile: 'truecolor',
 			codexTuiGlyphMode: 'ascii',
+			maskEmail: false,
+			maskEmailInQuotaDetails: false,
 			beginnerSafeMode: false,
 			fastSession: false,
 			fastSessionStrategy: 'hybrid',
@@ -438,6 +452,50 @@ describe('Plugin Configuration', () => {
 		});
 	});
 
+	describe('getCodexTuiMaskEmail', () => {
+		it('should default to false', () => {
+			delete process.env.CODEX_TUI_MASK_EMAIL;
+			expect(getCodexTuiMaskEmail({})).toBe(false);
+		});
+
+		it('should use config value when env var not set', () => {
+			delete process.env.CODEX_TUI_MASK_EMAIL;
+			expect(getCodexTuiMaskEmail({ maskEmail: true })).toBe(true);
+		});
+
+		it('should prioritize env value over config', () => {
+			process.env.CODEX_TUI_MASK_EMAIL = '0';
+			expect(getCodexTuiMaskEmail({ maskEmail: true })).toBe(false);
+			process.env.CODEX_TUI_MASK_EMAIL = '1';
+			expect(getCodexTuiMaskEmail({ maskEmail: false })).toBe(true);
+		});
+	});
+
+	describe('getCodexTuiMaskEmailInQuotaDetails', () => {
+		it('should default to false', () => {
+			delete process.env.CODEX_TUI_MASK_EMAIL_DETAILS;
+			expect(getCodexTuiMaskEmailInQuotaDetails({})).toBe(false);
+		});
+
+		it('should use config value when env var not set', () => {
+			delete process.env.CODEX_TUI_MASK_EMAIL_DETAILS;
+			expect(
+				getCodexTuiMaskEmailInQuotaDetails({ maskEmailInQuotaDetails: true }),
+			).toBe(true);
+		});
+
+		it('should prioritize env value over config', () => {
+			process.env.CODEX_TUI_MASK_EMAIL_DETAILS = '0';
+			expect(
+				getCodexTuiMaskEmailInQuotaDetails({ maskEmailInQuotaDetails: true }),
+			).toBe(false);
+			process.env.CODEX_TUI_MASK_EMAIL_DETAILS = '1';
+			expect(
+				getCodexTuiMaskEmailInQuotaDetails({ maskEmailInQuotaDetails: false }),
+			).toBe(true);
+		});
+	});
+
 	describe('getFastSession', () => {
 		it('should default to false', () => {
 			delete process.env.CODEX_AUTH_FAST_SESSION;
@@ -766,4 +824,3 @@ describe('Plugin Configuration', () => {
 		});
 	});
 });
-