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: describe repository examples (#649)

mldangelo-oaia55f3428d78d
diff --git a/examples/README.md b/examples/README.md
index 170e713da..b116441ea 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -3,9 +3,17 @@
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.
+ `codex-security publish scan --to cloud --csv PATH`. Copy it, add one finding
+ per row, and validate the file before publishing:
+
+ ```bash
+ npx @openai/codex-security publish scan --to cloud \
+ --csv /path/to/findings.csv --dry-run --json
+ ```
+
+ See [Publish findings to Cloud](../sdk/typescript/README.md#publish-findings-to-cloud)
+ for the required columns and input rules.
+
- [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.