From 035b003dc7e2a5886aa946d781bce481a7c80d45 Mon Sep 17 00:00:00 2001 From: lforst <8118419+lforst@users.noreply.github.com> Date: Fri, 24 Jul 2026 14:09:27 +0000 Subject: [PATCH] docs: Clarify need for API key --- README.md | 16 ++++++++++++++-- plugins/trace-codex/README.md | 18 +++++++++++++++++- 2 files changed, 31 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4f68f89..5328258 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,25 @@ Add this repo as a Codex plugin marketplace: ```bash codex plugin marketplace add braintrustdata/braintrust-codex-plugin -# OPTINAL: TRACE CODEX PLUGIN +# OPTIONAL: TRACE CODEX PLUGIN codex plugin add trace-codex@braintrust-codex-plugins -TRACE_TO_BRAINTRUST=true BRAINTRUST_PROJECT=my-coding-agent codex # OPTIONAL: SKILLS PLUGIN codex plugin add braintrust@braintrust-codex-plugins ``` +To use the tracing plugin, create an API key in Braintrust under **Settings > API keys**. The key must be available in the environment where Codex runs. Either export it in your current shell before starting Codex: + +```bash +export BRAINTRUST_API_KEY="" +TRACE_TO_BRAINTRUST=true BRAINTRUST_PROJECT=my-coding-agent codex +``` + +Or set it for only that Codex invocation: + +```bash +BRAINTRUST_API_KEY="" TRACE_TO_BRAINTRUST=true BRAINTRUST_PROJECT=my-coding-agent codex +``` + ## trace codex plugin see the plugin's [README](/plugins/trace-codex/README.md) for details and config options diff --git a/plugins/trace-codex/README.md b/plugins/trace-codex/README.md index 5ed6d46..cafbfee 100644 --- a/plugins/trace-codex/README.md +++ b/plugins/trace-codex/README.md @@ -7,10 +7,26 @@ A [Codex plugin](https://developers.openai.com/codex/plugins) that wires Codex l ```bash codex plugin marketplace add braintrustdata/braintrust-codex-plugin codex plugin add trace-codex@braintrust-codex-plugins +``` + +Create an API key in Braintrust under **Settings > API keys**. The key must be available in the environment where Codex runs. Either export it in your current shell before starting Codex: + +```bash +export BRAINTRUST_API_KEY="" # NOTE: tracing must be explicitly enabled # upon first run, codex will prompt for plugin permissions TRACE_TO_BRAINTRUST=true BRAINTRUST_PROJECT=my-coding-agent codex -# to upgrade: +``` + +Or set it for only that Codex invocation: + +```bash +BRAINTRUST_API_KEY="" TRACE_TO_BRAINTRUST=true BRAINTRUST_PROJECT=my-coding-agent codex +``` + +To upgrade: + +```bash codex plugin marketplace upgrade braintrust-codex-plugins ```