Skip to content

docs: Clarify need for API key #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Luca Forstner (lforst) merged 1 commit into from
Jul 24, 2026
Merged

docs: Clarify need for API key #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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="<your-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="<your-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
Expand Down
18 changes: 17 additions & 1 deletion plugins/trace-codex/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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="<your-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="<your-braintrust-api-key>" TRACE_TO_BRAINTRUST=true BRAINTRUST_PROJECT=my-coding-agent codex
```

To upgrade:

```bash
codex plugin marketplace upgrade braintrust-codex-plugins
```

Expand Down
Loading