Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

docs(examples): add overview and clarify npm packaging (#648)

Kyle Brownb054e8ba9076
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 000000000..170e713da
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,22 @@
+# Examples
+
+Examples and templates for using Codex Security:
+
+- [Findings CSV template](findings.csv): a header-only template for
+ `codex-security publish scan --to cloud --csv PATH`. Copy it and add your
+ findings before publishing. See the [CLI documentation](../sdk/typescript/README.md)
+ for the CSV format and dry-run options.
+- [Custom validation demo](custom-validation/README.md): run a scan with a custom
+ validation script against a deliberately vulnerable API using synthetic data.
+ Follow the demo's setup instructions, and do not deploy the example app.
+
+## npm package
+
+This top-level `examples/` directory is available in the repository only; it is
+not included in the `@openai/codex-security` npm package. The package is built
+from [`sdk/typescript`](../sdk/typescript/package.json), whose `files` list
+includes only the CLI launcher, compiled SDK, bundled plugin, license, and
+package README. The package check rejects files outside its expected contents.
+
+The bundled plugin's own example artifacts are separate and remain part of the
+package.