OpenAI Codex Security：革命性CLI与TypeScript SDK，三步解决代码安全漏洞

【免费下载链接】codex-security OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security 项目地址: https://gitcode.com/gh_mirrors/co/codex-security

OpenAI Codex Security是一款强大的CLI和TypeScript SDK工具，专为发现、验证和修复代码中的安全漏洞而设计。通过简单的安装、登录和扫描三个步骤，即可帮助开发者轻松提升代码安全性，是保障项目安全的终极解决方案。

一、快速上手：三步完成代码安全扫描 🚀

1.1 一键安装，即刻启用

安装OpenAI Codex Security非常简单，只需在终端中运行以下命令，即可通过npm快速安装：

npm install @openai/codex-security

这条命令会将最新版本的@openai/codex-security包下载并安装到你的项目中，让你随时可以使用其强大的安全扫描功能。

1.2 轻松登录，安全验证

安装完成后，需要进行登录验证。你可以通过以下命令登录：

npx @openai/codex-security login

如果是在远程或无头机器上，还可以使用--device-auth选项进行设备授权登录：

npx @openai/codex-security login --device-auth

此外，你也可以通过设置OPENAI_API_KEY或CODEX_API_KEY环境变量来进行身份验证，或者使用以下命令通过API密钥登录：

printenv OPENAI_API_KEY | npx @openai/codex-security login --with-api-key

1.3 执行扫描，守护代码安全

登录成功后，就可以对代码进行安全扫描了。使用以下命令扫描当前目录：

npx @openai/codex-security scan .

你还可以根据需求添加各种参数来定制扫描。例如，指定更高级的模型和更高的扫描力度：

npx @openai/codex-security scan . --model gpt-5.6-terra --effort high

如果只想扫描特定路径，可以使用--path参数：

npx @openai/codex-security scan /path/to/repository --path src --path tests

二、核心功能：全方位保障代码安全 🔒

2.1 多样化扫描模式，满足不同需求

OpenAI Codex Security提供了多种扫描模式，以适应不同的使用场景。除了基本的全量扫描外，还支持：

• 差异扫描：使用--diff参数扫描与指定分支（如origin/main）相比的代码变更，专注于最新修改的部分，提高扫描效率。

npx @openai/codex-security scan /path/to/repository --diff origin/main --json

• 工作树扫描：通过--working-tree参数扫描暂存和未暂存的更改，在提交代码前及时发现问题。

• 深度扫描：支持对仓库和路径目标进行深度扫描，更全面地检查潜在安全漏洞。

2.2 灵活的输出与报告功能

扫描结果可以灵活地输出和保存，方便后续分析和处理。你可以使用--output-dir参数指定扫描结果的输出目录：

npx @openai/codex-security scan /path/to/repository --output-dir /path/outside/repository/results

若想将结果以不同格式导出，可使用export命令，支持CSV、JSON和SARIF等格式：

npx @openai/codex-security export /path/outside/repository/results --export-format sarif --output /path/outside/repository/results.sarif
npx @openai/codex-security export /path/outside/repository/results --export-format csv --output /path/outside/repository/findings.csv
npx @openai/codex-security export /path/outside/repository/results --export-format json --output /path/outside/repository/findings.json

2.3 扫描历史与管理

OpenAI Codex Security还提供了扫描历史管理功能，方便你跟踪和比较不同时间的扫描结果。使用以下命令可以列出当前仓库的扫描记录：

npx @openai/codex-security scans list /path/to/repository

若要查看某次扫描的详细信息，包括配置、结果、覆盖率和 artifact 位置等，可使用：

npx @openai/codex-security scans show SCAN_ID

你还可以重新运行某次扫描：

npx @openai/codex-security scans rerun SCAN_ID

以及比较两次扫描的结果差异：

npx @openai/codex-security scans compare PREVIOUS_SCAN_ID CURRENT_SCAN_ID

三、高级应用：提升开发效率与安全性 ⚡

3.1 批量扫描，高效处理多仓库

对于需要管理多个仓库的开发者，OpenAI Codex Security提供了批量扫描功能。使用bulk-scan命令可以同时扫描多个仓库：

npx @openai/codex-security bulk-scan

你也可以指定模型和扫描力度：

npx @openai/codex-security bulk-scan --model gpt-5.6-terra --effort high

若有预先准备好的仓库列表CSV文件，可使用以下命令进行扫描：

npx @openai/codex-security bulk-scan repositories.csv --output-dir /path/outside/repositories/security-scans --workers 4

其中--workers参数用于限制并发扫描的数量，--max-attempts可设置失败重试次数。

3.2 集成到CI流程，自动化安全检测

为了在开发过程中自动进行安全检测，你可以将OpenAI Codex Security集成到CI流程中。通过设置适当的参数，如--fail-on-severity，可以在发现指定严重程度的漏洞时使扫描失败，从而阻止不安全的代码合并：

npx @openai/codex-security scan . --fail-on-severity high

此外，还可以使用install-hook命令安装预提交钩子，在每次提交前扫描暂存和未暂存的更改：

npx @openai/codex-security install-hook

3.3 自定义扫描策略，控制成本与风险

OpenAI Codex Security允许你自定义扫描策略，以平衡扫描成本和安全风险。使用--max-cost参数可以设置扫描的最大预算，当预估成本达到该值时停止扫描：

npx @openai/codex-security scan /path/to/repository --max-cost 5

每个扫描都会在其JSON结果、扫描历史和批量扫描收据中记录所使用的模型、令牌和预估成本，帮助你更好地控制扫描开销。

四、TypeScript SDK：深度集成，灵活扩展 🛠️

除了CLI工具外，OpenAI Codex Security还提供了TypeScript SDK，方便你在代码中深度集成安全扫描功能。通过导入CodexSecurity类，你可以创建客户端并进行扫描：

import { CodexSecurity } from "@openai/codex-security";

async function runScan() {
  const codex = new CodexSecurity();
  const result = await codex.scan({
    repository: "/path/to/repository",
    model: "gpt-5.6-terra",
    effort: "high",
    // 其他扫描选项
  });
  console.log(result.findings);
}

runScan().catch(console.error);

SDK提供了丰富的API，包括设置onReconnect来观察长时间运行的扫描，以及使用AbortSignal来取消扫描等功能，让你能够根据项目需求灵活地扩展和定制安全扫描流程。

五、总结：代码安全的得力助手 🛡️

OpenAI Codex Security以其简单易用的CLI和功能强大的TypeScript SDK，为开发者提供了全方位的代码安全解决方案。通过三步式的操作流程，你可以快速上手并开始保护你的项目。多样化的扫描模式、灵活的输出报告、扫描历史管理以及高级的批量扫描和CI集成功能，使其成为提升开发效率和代码安全性的得力助手。无论是个人项目还是大型企业应用，OpenAI Codex Security都能为你的代码安全保驾护航。

要开始使用，只需克隆仓库：

git clone https://gitcode.com/gh_mirrors/co/codex-security

然后按照上述步骤进行安装、登录和扫描，开启你的代码安全之旅！

【免费下载链接】codex-security OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security 项目地址: https://gitcode.com/gh_mirrors/co/codex-security