Skip to content

docs: Document file path render style option #13

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
cameroncooke merged 1 commit into from
May 7, 2026
+20 −0
Merged

docs: Document file path render style option #13

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
5 changes: 5 additions & 0 deletions app/docs/_content/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,13 @@ xcodebuildmcp simulator build --json '{"scheme":"MyApp","projectPath":"./MyApp.x

# Output format
xcodebuildmcp simulator list --output json

# File artifact layout in text/raw output
xcodebuildmcp simulator build --file-path-render-style tree
```

`--file-path-render-style list|tree` overrides the text rendering style for file artifacts on one invocation. The default CLI text style is `list`; MCP text defaults to `tree`. JSON and JSONL output are unaffected.

## Session defaults auto-fill

If your project has `.xcodebuildmcp/config.yaml` with `sessionDefaults` set, the CLI fills matching flags automatically:
Expand Down
4 changes: 4 additions & 0 deletions app/docs/_content/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ sessionDefaults:
# Build settings
incrementalBuildsEnabled: false

# Text output
filePathRenderStyle: "list" # "list" or "tree"

# Debugging and telemetry
debug: false
sentryDisabled: false
Expand Down Expand Up @@ -113,6 +116,7 @@ macosTemplateVersion: "v1.2.3"
| `sessionDefaultsProfiles` | object | `{}` |
| `activeSessionDefaultsProfile` | string | `global` |
| `incrementalBuildsEnabled` | boolean | `false` |
| `filePathRenderStyle` | `"list" \| "tree"` | CLI text: `"list"`, MCP text: `"tree"` |
| `debug` | boolean | `false` |
| `sentryDisabled` | boolean | `false` |
| `debuggerBackend` | string | `"dap"` |
Expand Down
1 change: 1 addition & 0 deletions app/docs/_content/env-vars.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Set env vars in the `env` field of your MCP client config (for example `mcp_conf
| `disableSessionDefaults` | `XCODEBUILDMCP_DISABLE_SESSION_DEFAULTS` |
| `disableXcodeAutoSync` | `XCODEBUILDMCP_DISABLE_XCODE_AUTO_SYNC` |
| `incrementalBuildsEnabled` | `INCREMENTAL_BUILDS_ENABLED` |
| `filePathRenderStyle` | `XCODEBUILDMCP_FILE_PATH_RENDER_STYLE` (`list` or `tree`) |
| `debug` | `XCODEBUILDMCP_DEBUG` |
| `sentryDisabled` | `XCODEBUILDMCP_SENTRY_DISABLED` |
| `debuggerBackend` | `XCODEBUILDMCP_DEBUGGER_BACKEND` |
Expand Down
10 changes: 10 additions & 0 deletions app/docs/_content/output-formats.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ Next steps:

Use `text` for normal agent workflows. Agents can read summaries, diagnostics, and next-step commands without needing a JSON parser.

CLI text renders file artifacts as labeled rows under `Files:` by default:

```text
Files:
├ App Path: ~/Library/Developer/XcodeBuildMCP/.../MyApp.app
└ Build Logs: ~/Library/Developer/XcodeBuildMCP/.../build.log
```

Use `--file-path-render-style tree` for the compact grouped tree used by MCP text responses, or set `filePathRenderStyle: "tree"` / `XCODEBUILDMCP_FILE_PATH_RENDER_STYLE=tree`. This setting only affects human-readable text; `--output json` and `--output jsonl` keep the same structured fields.

## `--output json`

`json` prints a structured JSON response to stdout after the tool finishes. It does not stream progress. Use it when you need stable fields for scripts or CI.
Expand Down
Loading