You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/install-guides/codex-cli.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,11 @@ Codex CLI is a lightweight coding agent from OpenAI that runs locally in your te
20
20
21
21
It supports multiple operating systems, including Arm-based Linux distributions and macOS.
22
22
23
+
This guide explains how to install Codex CLI on macOS and Arm Linux.
24
+
23
25
## What should I do before installing Codex CLI?
24
26
25
-
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.
26
28
27
29
Codex CLI requires Node.js 18 or later.
28
30
@@ -42,7 +44,7 @@ npm install -g @openai/codex
42
44
43
45
### Can I use Homebrew to install Codex CLI on macOS?
44
46
45
-
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.
46
48
47
49
Install Codex CLI using Homebrew:
48
50
@@ -70,7 +72,7 @@ If you are not using Ubuntu/Debian use your package manager to install curl.
70
72
71
73
Codex CLI requires Node.js version 18 or higher. The easiest way to install Node.js on Arm Linux is using the NodeSource repository.
72
74
73
-
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):
@@ -145,8 +147,7 @@ Run the `codex` command and select **Sign in with ChatGPT** to authenticate:
145
147
```console
146
148
codex
147
149
```
148
-
149
-
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.
150
151
151
152
**Option 2: Use an OpenAI API key**
152
153
@@ -158,7 +159,7 @@ Set the `OPENAI_API_KEY` environment variable:
158
159
export OPENAI_API_KEY=your-api-key-here
159
160
```
160
161
161
-
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.
162
163
163
164
You can generate an API key from the [OpenAI Platform](https://platform.openai.com/api-keys).
164
165
@@ -175,7 +176,7 @@ You can configure various options including the default model, approval mode, an
175
176
To see all configuration options, refer to the [Configuration documentation](https://developers.openai.com/codex/cli/reference/).
176
177
177
178
178
-
## Install a local MCP server
179
+
## Install the Arm MCP server
179
180
180
181
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.
181
182
@@ -184,12 +185,11 @@ First, pull the MCP server image to your local machine:
184
185
```console
185
186
docker pull armlimited/arm-mcp:latest
186
187
```
187
-
188
-
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.
189
189
190
190
### How do I configure the Arm MCP server?
191
191
192
-
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.
193
193
194
194
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.
195
195
@@ -223,7 +223,7 @@ Start Codex CLI and list the tools from the MCP server to verify it is working:
223
223
codex
224
224
```
225
225
226
-
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:
227
227
228
228
```console
229
229
/mcp
@@ -235,4 +235,4 @@ You can also verify the tools are available by asking Codex to list the availabl
235
235
236
236
If you are facing issues or have questions, reach out to mcpserver@arm.com.
237
237
238
-
You're ready to use Codex CLI with Arm development tools.
0 commit comments