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
docs: Unify installation sections and update for v2.0.0 stable
Restructure README and GETTING_STARTED installation sections into
two clear paths (Homebrew vs npm/npx) with a single-package intro.
Replace all stale @beta references with @latest to match the 2.0.0
stable release. Add Homebrew substitution note before client-specific
config sections. Document AXe local bundling and release workflow
modes.
Co-Authored-By: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+36-10Lines changed: 36 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,24 +7,52 @@ A Model Context Protocol (MCP) server and CLI that provides tools for agent use
7
7
8
8
## Installation
9
9
10
-
### CLI Installation
10
+
XcodeBuildMCP ships as a single package with two modes: a **CLI** for direct terminal use and an **MCP server** for AI coding agents. Both installation methods give you both modes.
11
+
12
+
### Option A — Homebrew
11
13
12
14
```bash
13
-
npm install -g xcodebuildmcp@latest
15
+
brew tap cameroncooke/xcodebuildmcp
16
+
brew install xcodebuildmcp
17
+
```
18
+
19
+
Use the CLI:
20
+
```bash
14
21
xcodebuildmcp --help
15
22
```
16
23
17
-
### MCP Server Installation
24
+
MCP client config:
25
+
```json
26
+
"XcodeBuildMCP": {
27
+
"command": "xcodebuildmcp",
28
+
"args": ["mcp"]
29
+
}
30
+
```
31
+
32
+
Upgrade later with `brew update && brew upgrade xcodebuildmcp`.
18
33
19
-
Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON configuration with the following server entry:
34
+
### Option B — npm / npx (Node.js 18+)
20
35
36
+
**For CLI use**, install globally:
37
+
```bash
38
+
npm install -g xcodebuildmcp@latest
39
+
xcodebuildmcp --help
40
+
```
41
+
42
+
**For MCP server only**, no global install needed — add directly to your client config:
21
43
```json
22
44
"XcodeBuildMCP": {
23
45
"command": "npx",
24
46
"args": ["-y", "xcodebuildmcp@latest", "mcp"]
25
47
}
26
48
```
27
49
50
+
To pin a specific version, replace `@latest` with an exact version (e.g. `xcodebuildmcp@2.0.0`).
51
+
52
+
### Client-specific setup
53
+
54
+
The examples below use npx (Option B). If you installed via Homebrew, replace the command with `"command": "xcodebuildmcp", "args": ["mcp"]` instead.
55
+
28
56
<details>
29
57
<summary>Cursor</summary>
30
58
<br />
@@ -188,7 +216,7 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
188
216
tool_timeout_sec = 10000
189
217
```
190
218
191
-
> **NOTE**:
219
+
> **NOTE**:
192
220
> Codex Agent when running in Xcode has a limited PATH by default. The above example should work for most users but if you find the server doesn't start or is not available, it's likely because npx is not found so you might have to adjust the above configuration accordingly.
193
221
194
222
<br />
@@ -217,23 +245,21 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
217
245
}
218
246
```
219
247
220
-
> **NOTE**:
248
+
> **NOTE**:
221
249
> Claude Code Agent when running in Xcode has a limited PATH by default. The above example should work for most users but if you find the server doesn't start or is not available, it's likely because npx is not found so you might have to adjust the above configuration accordingly.
222
250
223
251
<br />
224
252
</details>
225
253
226
254
<br />
227
255
228
-
For other installation options see [Getting Started](docs/GETTING_STARTED.md)
229
-
230
-
When configuring a client manually, ensure the command includes the `mcp` subcommand (for example, `npx -y xcodebuildmcp@latest mcp`).
256
+
For other installation options see [Getting Started](docs/GETTING_STARTED.md).
231
257
232
258
## Requirements
233
259
234
260
- macOS 14.5 or later
235
261
- Xcode 16.x or later
236
-
- Node.js 18.x or later
262
+
- Node.js 18.x or later (not required for Homebrew installation)
0 commit comments