Skip to content

docs: Add Codex CLI configuration guide #305

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

Open
vincent067 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Add Codex CLI configuration guide #305

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f64822
docs: add Codex CLI configuration guide
Mar 26, 2026
b26bcf2
docs: add Codex CLI configuration guide
Mar 26, 2026
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
57 changes: 57 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,63 @@ docker run -p 8080:8080 --rm -e TRANSPORT_MODE=streamable-http -e TRANSPORT_HOST
claude mcp add --transport http terraform http://localhost:8080/mcp
```

### Usage with Codex CLI

[Codex CLI](https://github.com/openai/codex) is OpenAI's official coding agent that runs in your terminal. It supports MCP servers for extended capabilities.

#### Prerequisites

- Node.js 18+ installed
- [Codex CLI](https://github.com/openai/codex) installed: `npm install -g @openai/codex`
- OpenAI API key configured

#### Configuration

Codex CLI uses a JSON configuration file for MCP servers. Add the Terraform MCP server to your Codex config at `~/.codex/config.json`:

**Stdio Transport (Recommended)**

```json
{
"mcpServers": {
"terraform": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "TFE_ADDRESS=<<PASTE_TFE_ADDRESS_HERE>>",
"-e", "TFE_TOKEN=<<PASTE_TFE_TOKEN_HERE>>",
"hashicorp/terraform-mcp-server:0.4.0"
]
}
}
}
```

**HTTP Transport**

```bash
# Run the MCP server in HTTP mode
docker run -p 8080:8080 --rm -e TRANSPORT_MODE=streamable-http -e TRANSPORT_HOST=0.0.0.0 hashicorp/terraform-mcp-server:0.4.0

# Add to Codex CLI config
openai config set mcpServers.terraform.url=http://localhost:8080/mcp
```

#### Usage Examples

Once configured, you can use Terraform tools within Codex:

```bash
codex "Search for AWS providers in the Terraform Registry"
codex "List my HCP Terraform workspaces"
codex "Create a new Terraform workspace for the staging environment"
```

For more details on MCP configuration in Codex, refer to the [Codex CLI documentation](https://github.com/openai/codex/tree/main/codex-cli#mcp-agent-mode).


### Usage with Gemini extensions

For security, avoid hardcoding your credentials, create or update `~/.gemini/.env` (where ~ is your home or project directory) for storing HCP Terraform or Terraform Enterprise credentials
Expand Down
Loading