Skip to content

Commit e6a9dc5

Browse files
authored
Update codex-cli.md
1 parent 5768fc9 commit e6a9dc5

1 file changed

Lines changed: 9 additions & 11 deletions

File tree

content/install-guides/codex-cli.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This guide explains how to install Codex CLI on macOS and Arm Linux.
2424

2525
## What should I do before installing Codex CLI?
2626

27-
You need an OpenAI account to use Codex CLI. You can either sign in with your ChatGPT account (Plus, Pro, Team, Edu, or Enterprise plan) or use an OpenAI API key.
27+
You need an OpenAI account to use Codex CLI. You can either sign in with your [ChatGPT](https://chatgpt.com/) account (Plus, Pro, Team, Edu, or Enterprise plan) or use an OpenAI API key.
2828

2929
Codex CLI requires Node.js 18 or later.
3030

@@ -44,7 +44,7 @@ npm install -g @openai/codex
4444

4545
### Can I use Homebrew to install Codex CLI on macOS?
4646

47-
Yes, you can install [Homebrew](https://brew.sh/) if it's not already available on your computer.
47+
Yes. Install [Homebrew](https://brew.sh/) if it's not already available on your computer.
4848

4949
Install Codex CLI using Homebrew:
5050

@@ -72,7 +72,7 @@ If you are not using Ubuntu/Debian use your package manager to install curl.
7272

7373
Codex CLI requires Node.js version 18 or higher. The easiest way to install Node.js on Arm Linux is using the NodeSource repository.
7474

75-
Download and run the Node.js 22.x setup script:
75+
Download and run the Node.js setup script (example shown for Node.js 22.x):
7676

7777
```bash
7878
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
@@ -147,8 +147,7 @@ Run the `codex` command and select **Sign in with ChatGPT** to authenticate:
147147
```console
148148
codex
149149
```
150-
151-
Follow the prompts to sign in with your OpenAI account. This is recommended if you have a ChatGPT Plus, Pro, Team, Edu, or Enterprise plan.
150+
This opens a browser window to complete authentication. This option is recommended if you have a ChatGPT Plus, Pro, Team, Edu, or Enterprise plan.
152151

153152
**Option 2: Use an OpenAI API key**
154153

@@ -160,7 +159,7 @@ Set the `OPENAI_API_KEY` environment variable:
160159
export OPENAI_API_KEY=your-api-key-here
161160
```
162161

163-
To make this permanent, add the export command to your shell configuration file (such as `~/.bashrc` or `~/.zshrc`).
162+
Add this command to your shell configuration file (such as ~/.bashrc or ~/.zshrc) to make it permanent.
164163

165164
You can generate an API key from the [OpenAI Platform](https://platform.openai.com/api-keys).
166165

@@ -177,7 +176,7 @@ You can configure various options including the default model, approval mode, an
177176
To see all configuration options, refer to the [Configuration documentation](https://developers.openai.com/codex/cli/reference/).
178177

179178

180-
## Install a local MCP server
179+
## Install the Arm MCP server
181180

182181
The Arm MCP Server is an MCP server providing AI assistants with tools and knowledge for Arm architecture development, migration, and optimization. This section shows how to configure the Arm MCP server locally using Docker.
183182

@@ -186,12 +185,11 @@ First, pull the MCP server image to your local machine:
186185
```console
187186
docker pull armlimited/arm-mcp:latest
188187
```
189-
190-
You also need Docker running on the system. See the [Docker install guide](/install-guides/docker/) for instructions.
188+
Ensure Docker is installed and running. See the [Docker install guide](/install-guides/docker/) for instructions.
191189

192190
### How do I configure the Arm MCP server?
193191

194-
Codex CLI uses a TOML configuration file for MCP servers. Modify the file `~/.codex/config.toml` to add the Arm MCP server via a Docker container.
192+
Codex CLI uses a TOML configuration file for MCP servers. Modify the file `~/.codex/config.toml` to add the Arm MCP server using Docker.
195193

196194
To analyze a local codebase, use a `-v` argument to mount a volume to the Arm MCP server `/workspace` folder so it can access code you want to analyze with migrate-ease and other tools.
197195

@@ -225,7 +223,7 @@ Start Codex CLI and list the tools from the MCP server to verify it is working:
225223
codex
226224
```
227225

228-
Use the `/mcp` command to view active MCP servers and their status:
226+
At the Codex prompt, run the `/mcp` command to view active MCP servers and their status:
229227

230228
```console
231229
/mcp

0 commit comments

Comments
 (0)