概要
@openai/codex-security は、コード内の セキュリティ脆弱性 を検出・修正するCLIおよびTypeScript SDK。 リポジトリのスキャン、変更のレビュー、脆弱性の追跡、CI連携などに対応。 Node.js 22以上、 Python 3.10以上、Codex Securityへのアクセスが必要。 インストールと利用方法 はnpmおよび公式ドキュメント参照。 TypeScript SDK も提供され、プログラムから直接利用可能。
@openai/codex-securityの概要
- CLIとTypeScript SDK の両方を提供するセキュリティツール
- コードの脆弱性検出、バリデーション、修正機能
- リポジトリ全体のスキャン や 変更点のレビュー が可能
- 脆弱性の履歴管理 や CIでの自動チェック 対応
- Node.js 22以上、 Python 3.10以上 の環境が必要条件
インストールと初期設定
- npm でのインストールが可能
npm install @openai/codex-security
- 初回ログイン には以下コマンドを利用
npx codex-security login
- スキャン実行 コマンド
npx codex-security scan .
- CI環境 では OPENAI_API_KEY 環境変数を設定し、サインイン不要
TypeScript SDKの利用方法
- CodexSecurityクラス をインポートしてインスタンス化
import { CodexSecurity } from "@openai/codex-security";
- runメソッド で指定ディレクトリをスキャン
const result = await security.run(".");
- レポートパスの取得 や リソース解放
console.log(result.reportPath);await security.close();
公式ドキュメント参照推奨事項
- インストール手順
- 認証方法
- スキャンオプション
- CI環境構築方法
- 詳細情報は 公式ドキュメント で確認