@qqq123456789/codex-doctor 0.8.0 → 1.0.0

package/README.en.md

@@ -14,6 +14,8 @@ English | [中文](README.md)
 [![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux%20%7C%20WSL-lightgrey)](docs/06-sandbox-windows.md)
 
 > 📖 **Read online**：<https://qlw088697-ui.github.io/codex-troubleshooting/> (docsify site with full-text search, kept in sync with this repo)
+>
+> 📄 Prefer offline? Every release attaches a merged **PDF handbook** (`node scripts/build-pdf.mjs` regenerates it) — see [Releases](https://github.com/qlw088697-ui/codex-troubleshooting/releases).
 
 ## Quick start: run the environment self-check first
 

package/README.md

@@ -45,6 +45,8 @@ curl -fsSL https://raw.githubusercontent.com/qlw088697-ui/codex-troubleshooting/
 
 （也可以下载 `scripts/` 目录里的脚本本地运行。脚本只读环境信息，不会修改任何配置。）
 
+> 📄 喜欢离线阅读？每次发版都会在 [Releases](https://github.com/qlw088697-ui/codex-troubleshooting/releases) 附上合并排版的 PDF 手册（`node scripts/build-pdf.mjs` 可自行生成）。
+
 ## 🛠️ 配套工具：codex-doctor CLI
 
 把本手册的检查与维护做成了一条条命令（零依赖，Node 18.15+）：

package/docs/13-codex-doctor.en.md

@@ -31,7 +31,10 @@ node codex-troubleshooting/tool/cli.mjs --help
 | `archive list` | List archive folders with sizes | read-only |
 | `archive delete <name\|--all>` | Delete archives (interactive confirm by default, `--yes` to skip) | medium (deletes, requires confirm) |
 | `versions [-n 10]` | List the latest openai/codex releases (prerelease flagged) | read-only |
+| `config` | Read-only summary: model / provider / approval & sandbox / profiles / relays / MCP / auth mode (secrets masked) | read-only |
 | `sessions [-n 10] [--dir keyword]` | Browse past sessions: time, workdir, source, first-prompt preview; `--dir` filters by directory — find "that conversation" | read-only |
+| `sessions --search keyword [--deep]` | Search sessions by keyword (first 256KB of each file by default, `--deep` scans fully) | read-only |
+| `sessions --show [--search keyword] [--pick N] [--full]` | Print a session's full transcript (latest by default; messages truncated to 400 chars unless `--full`) | read-only |
 | `update` | Check the latest npm version and how to update | read-only |
 
 ## Design principles

package/docs/13-codex-doctor.md

@@ -31,7 +31,10 @@ node codex-troubleshooting/tool/cli.mjs --help
 | `archive list` | 查看归档目录与体积 | 只读 |
 | `archive delete <名称\|--all>` | 删除归档（默认需交互确认，`--yes` 跳过） | 中（删除，需确认） |
 | `versions [-n 10]` | 查看 openai/codex 最近 N 个版本（含预发布标记） | 只读 |
+| `config` | 只读摘要：模型 / provider / 审批沙箱 / profiles / 中转 / MCP / 认证方式（敏感值脱敏） | 只读 |
 | `sessions [-n 10] [--dir 关键字]` | 浏览历史会话：时间、工作目录、来源、首条提问预览；`--dir` 按目录过滤，找回「上次那个对话」 | 只读 |
+| `sessions --search 关键词 [--deep]` | 按关键词搜索会话（默认搜每个文件开头 256KB，`--deep` 全文扫描） | 只读 |
+| `sessions --show [--search 关键词] [--pick N] [--full]` | 查看会话完整对话（默认最近一次；默认单条截断 400 字） | 只读 |
 | `update` | 查询 npm 上工具的最新版本与更新方式 | 只读 |
 
 ## 设计原则

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "@qqq123456789/codex-doctor",
-  "version": "0.8.0",
+  "version": "1.0.0",
+  "scripts": {
+    "test": "bash scripts/test-codex-doctor.sh",
+    "check:links": "bash scripts/check-links.sh",
+    "check:consistency": "bash scripts/check-consistency.sh"
+  },
   "description": "Codex CLI 维护与排障工具：环境自检、会话/日志归档、配置与凭据备份恢复、版本追踪（零依赖）",
   "keywords": [
     "codex",

package/tool/cli.mjs

@@ -3,11 +3,12 @@
 import { collectChecks, summarize, renderHuman } from './checks.mjs';
 import { cleanTarget } from './clean.mjs';
 import { backupConfig, restoreBackup, resetAuth, listVersions, listArchives, deleteArchive, checkUpdate } from './ops.mjs';
-import { listSessions, searchSessions, readTranscript } from './sessions.mjs';
+import { listSessions, searchSessions, readTranscript, exportTranscriptMarkdown } from './sessions.mjs';
+import { configSummary } from './config.mjs';
 import { CODEX_DIR } from './util.mjs';
 import path from 'node:path';
 
-const VERSION = '0.8.0';
+const VERSION = '1.0.0';
 
 const HELP = `codex-doctor v${VERSION} — Codex CLI 维护与排障工具（零依赖）
 
@@ -27,6 +28,7 @@ const HELP = `codex-doctor v${VERSION} — Codex CLI 维护与排障工具（零
   archive list                  查看归档目录与体积
   archive delete <名称|--all>   删除归档（需 --yes 或交互确认）
   versions [-n N]               查看 openai/codex 最近 N 个版本（默认 10）
+  config                        只读摘要：模型 / provider / 审批沙箱 / profiles / 中转 / MCP / 认证方式
   sessions [-n N] [--dir 关键字] 浏览历史会话：时间、目录、来源、首条提问预览
              [--search 关键词] [--deep] 按关键词搜索会话（--deep 全文扫描）
              --show [--search 关键词] [--pick N] [--full] 查看会话完整对话
@@ -151,6 +153,16 @@ async function main() {
         const item = items[pick - 1];
         console.log(`== 会话 ${item.date} @ ${item.dirName} ==`);
         console.log(`文件: ${item.file}\n`);
+        if (flags.out) {
+          // 导出为 Markdown 文件
+          const r = exportTranscriptMarkdown(item.file, flags.out, { maxLen: flags.full ? Infinity : 400 });
+          if (!r) {
+            console.log('（该会话没有可导出的对话消息）');
+            break;
+          }
+          console.log(`已导出 ${r.count} 条消息 → ${r.outFile}`);
+          break;
+        }
         const transcript = readTranscript(item.file, { maxLen: flags.full ? Infinity : 400 });
         if (!transcript || transcript.length === 0) {
           console.log('（该会话没有可展示的对话消息）');
@@ -199,6 +211,10 @@ async function main() {
       console.log(`\n会话文件位于 ${path.join(CODEX_DIR, 'sessions')}（-n 条数 / --dir 按目录关键字过滤）`);
       break;
     }
+    case 'config': {
+      for (const l of configSummary()) console.log(l);
+      break;
+    }
     case 'update': {
       const r = await checkUpdate(VERSION);
       print(r.lines);

package/tool/config.mjs

@@ -0,0 +1,82 @@
+// config：只读摘要——一条命令看懂 codex 当前有效配置（敏感信息脱敏）
+import fs from 'node:fs';
+import path from 'node:path';
+import { CODEX_DIR, exists } from './util.mjs';
+
+function host(u) {
+  try {
+    return new URL(u).host;
+  } catch {
+    return '(无效 URL)';
+  }
+}
+
+export function configSummary() {
+  const lines = [];
+  const cfg = path.join(CODEX_DIR, 'config.toml');
+  if (!exists(cfg)) {
+    lines.push('config.toml 不存在（全部使用默认配置）');
+    return lines;
+  }
+  const content = fs.readFileSync(cfg, 'utf8');
+
+  // 极简 TOML 分段解析：根级键 + 各表的 key=value（仅取本工具关心的键）
+  const root = {};
+  const tables = [];
+  let cur = null;
+  for (const raw of content.split(/\r?\n/)) {
+    const l = raw.trim();
+    if (!l || l.startsWith('#')) continue;
+    const tm = l.match(/^\[([^\]]+)\]$/);
+    if (tm) {
+      cur = tm[1].trim();
+      tables.push({ name: cur, kv: {} });
+      continue;
+    }
+    const kv = l.match(/^([A-Za-z0-9_-]+)\s*=\s*(.+)$/);
+    if (kv) {
+      const key = kv[1];
+      const val = kv[2].trim().replace(/^["']|["']$/g, '');
+      if (cur) tables[tables.length - 1].kv[key] = val;
+      else root[key] = val;
+    }
+  }
+
+  lines.push(`模型: ${root.model || '(默认)'}`);
+  lines.push(`provider: ${root.model_provider || 'openai（官方）'}`);
+  lines.push(`审批策略: ${root.approval_policy || '(默认)'}`);
+  lines.push(`沙箱模式: ${root.sandbox_mode || '(默认)'}`);
+
+  // 只显示「两段式」表名；更深的嵌套表（如 mcp_servers.x.env）是子配置，不是实体
+  const seg = (t) => t.name.split('.').length;
+  const profiles = tables.filter((t) => t.name.startsWith('profiles.') && seg(t) === 2);
+  if (profiles.length > 0) {
+    lines.push(`profiles: ${profiles.map((t) => t.name.replace('profiles.', '')).join(', ')}`);
+  }
+
+  const providers = tables.filter((t) => t.name.startsWith('model_providers.') && seg(t) === 2);
+  for (const p of providers) {
+    const id = p.name.replace('model_providers.', '');
+    const bu = p.kv.base_url ? host(p.kv.base_url) : '(未配置 base_url)';
+    const ek = p.kv.env_key ? `（Key 在环境变量 ${p.kv.env_key}，不显示）` : '';
+    lines.push(`中转 ${id}: ${bu}${ek}`);
+  }
+
+  const mcp = tables.filter((t) => t.name.startsWith('mcp_servers.') && seg(t) === 2);
+  if (mcp.length > 0) {
+    lines.push(`MCP servers: ${mcp.map((t) => t.name.replace('mcp_servers.', '')).join(', ')}`);
+  }
+
+  // 认证方式（不看内容，只看结构）
+  const auth = path.join(CODEX_DIR, 'auth.json');
+  if (exists(auth)) {
+    try {
+      const j = JSON.parse(fs.readFileSync(auth, 'utf8'));
+      if (j.tokens) lines.push('认证: ChatGPT 账号登录');
+      else if (j.OPENAI_API_KEY) lines.push('认证: API Key（已脱敏）');
+    } catch {
+      lines.push('auth.json 无法解析——可运行 codex-doctor auth reset 重置');
+    }
+  }
+  return lines;
+}

package/tool/sessions.mjs

@@ -1,7 +1,7 @@
 // sessions：浏览 ~/.codex/sessions 下的历史会话（只读）
 import fs from 'node:fs';
 import path from 'node:path';
-import { CODEX_DIR, exists, walkFiles } from './util.mjs';
+import { CODEX_DIR, exists, walkFiles, ensureDir } from './util.mjs';
 
 // 只读每个文件头部 64KB：meta 在第 1 行，真实提问通常也在最前面
 function readHead(file, bytes = 65536) {
@@ -154,3 +154,29 @@ export function readTranscript(file, { maxLen = 400 } = {}) {
   }
   return out;
 }
+
+// 把会话导出为 Markdown 文件（找回的对话可存档分享）
+export function exportTranscriptMarkdown(file, outFile, { maxLen = 400 } = {}) {
+  if (!exists(file)) return null;
+  const content = fs.readFileSync(file, 'utf8');
+  const { meta } = extract(content);
+  const transcript = readTranscript(file, { maxLen });
+  if (!transcript || transcript.length === 0) return null;
+
+  const lines = ['# Codex 会话记录', ''];
+  lines.push(`- 时间：${meta?.date || '?'}`);
+  lines.push(`- 工作目录：${meta?.cwd || '?'}`);
+  lines.push(`- 来源：${meta?.originator || '?'}`);
+  lines.push(`- 导出自：${file}`);
+  lines.push('');
+  for (const msg of transcript) {
+    lines.push(`## ${msg.role === 'user' ? '用户' : 'Codex'}`);
+    lines.push('');
+    lines.push(msg.text);
+    lines.push('');
+  }
+  const dest = path.resolve(outFile);
+  ensureDir(path.dirname(dest));
+  fs.writeFileSync(dest, lines.join('\n'), 'utf8');
+  return { outFile: dest, count: transcript.length };
+}