README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
## Advanced
2025-11-11 14:45:40 +01:00
If you already lean on LLMX every day and just need a little more control, this page collects the knobs you are most likely to reach for: tweak defaults in [Config ](./config.md ), add extra tools through [Model Context Protocol support ](#model-context-protocol ), and script full runs with [`llmx exec` ](./exec.md ). Jump to the section you need and keep building.
2025-10-19 15:07:33 -07:00
## Config quickstart {#config-quickstart}
Most day-to-day tuning lives in `config.toml` : set approval + sandbox presets, pin model defaults, and add MCP server launchers. The [Config guide ](./config.md ) walks through every option and provides copy-paste examples for common setups.
## Tracing / verbose logging {#tracing-verbose-logging}
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
2025-11-11 14:45:40 +01:00
Because LLMX is written in Rust, it honors the `RUST_LOG` environment variable to configure its logging behavior.
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
2025-11-11 14:45:40 +01:00
The TUI defaults to `RUST_LOG=codex_core=info,codex_tui=info,codex_rmcp_client=info` and log messages are written to `~/.llmx/log/llmx-tui.log` , so you can leave the following running in a separate terminal to monitor log messages as they are written:
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
2025-11-06 11:00:28 -06:00
```bash
2025-11-11 14:45:40 +01:00
tail -F ~/.llmx/log/llmx-tui.log
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
```
2025-11-11 14:45:40 +01:00
By comparison, the non-interactive mode (`llmx exec` ) defaults to `RUST_LOG=error` , but messages are printed inline, so there is no need to monitor a separate file.
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
See the Rust documentation on [`RUST_LOG` ](https://docs.rs/env_logger/latest/env_logger/#enabling-logging ) for more information on the configuration options.
2025-10-19 15:07:33 -07:00
## Model Context Protocol (MCP) {#model-context-protocol}
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
2025-11-11 14:45:40 +01:00
The LLMX CLI and IDE extension is a MCP client which means that it can be configured to connect to MCP servers. For more information, refer to the [`config docs` ](./config.md#mcp-integration ).
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
2025-11-11 14:45:40 +01:00
## Using LLMX as an MCP Server {#mcp-server}
2025-09-11 14:38:24 -07:00
2025-11-11 14:45:40 +01:00
The LLMX CLI can also be run as an MCP _ server _ via `llmx mcp-server` . For example, you can use `llmx mcp-server` to make LLMX available as a tool inside of a multi-agent framework like the OpenAI [Agents SDK ](https://platform.openai.com/docs/guides/agents ). Use `llmx mcp` separately to add/list/get/remove MCP server launchers in your configuration.
2025-09-11 14:38:24 -07:00
2025-11-11 14:45:40 +01:00
### LLMX MCP Server Quickstart {#mcp-server-quickstart}
2025-10-03 11:35:48 -07:00
2025-11-11 14:45:40 +01:00
You can launch a LLMX MCP server with the [Model Context Protocol Inspector ](https://modelcontextprotocol.io/legacy/tools/inspector ):
2025-09-11 14:38:24 -07:00
2025-10-03 11:35:48 -07:00
```bash
2025-11-11 14:45:40 +01:00
npx @modelcontextprotocol/inspector llmx mcp-server
2025-09-11 14:38:24 -07:00
```
2025-10-03 11:35:48 -07:00
2025-09-11 14:38:24 -07:00
Send a `tools/list` request and you will see that there are two tools available:
2025-11-11 14:45:40 +01:00
**`llmx` ** - Run a LLMX session. Accepts configuration parameters matching the LLMX Config struct. The `llmx` tool takes the following properties:
2025-09-11 14:38:24 -07:00
2025-10-20 11:05:55 -07:00
| Property | Type | Description |
2025-10-28 09:32:20 -07:00
| ----------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
2025-11-11 14:45:40 +01:00
| * * `prompt` ** (required) | string | The initial user prompt to start the LLMX conversation. |
2025-10-20 15:00:42 -07:00
| `approval-policy` | string | Approval policy for shell commands generated by the model: `untrusted` , `on-failure` , `on-request` , `never` . |
2025-10-20 11:05:55 -07:00
| `base-instructions` | string | The set of instructions to use instead of the default ones. |
2025-11-11 14:45:40 +01:00
| `config` | object | Individual [config settings ](https://github.com/valknar/llmx/blob/main/docs/config.md#config ) that will override what is in `$CODEX_HOME/config.toml` . |
2025-10-28 09:32:20 -07:00
| `cwd` | string | Working directory for the session. If relative, resolved against the server process's current directory. |
2025-10-20 11:05:55 -07:00
| `model` | string | Optional override for the model name (e.g. `o3` , `o4-mini` ). |
| `profile` | string | Configuration profile from `config.toml` to specify default options. |
| `sandbox` | string | Sandbox mode: `read-only` , `workspace-write` , or `danger-full-access` . |
2025-09-12 09:04:49 -07:00
2025-11-11 14:45:40 +01:00
**`llmx-reply` ** - Continue a LLMX session by providing the conversation id and prompt. The `llmx-reply` tool takes the following properties:
2025-09-11 14:38:24 -07:00
2025-10-03 11:35:48 -07:00
| Property | Type | Description |
| ------------------------------- | ------ | -------------------------------------------------------- |
2025-11-11 14:45:40 +01:00
| * * `prompt` ** (required) | string | The next user prompt to continue the LLMX conversation. |
2025-10-03 11:35:48 -07:00
| * * `conversationId` ** (required) | string | The id of the conversation to continue. |
2025-09-11 14:38:24 -07:00
2025-10-19 15:07:33 -07:00
### Trying it Out {#mcp-server-trying-it-out}
2025-10-03 11:35:48 -07:00
README / docs refactor (#2724)
This PR cleans up the monolithic README by breaking it into a set
navigable pages under docs/ (install, getting started, configuration,
authentication, sandboxing and approvals, platform details, FAQ, ZDR,
contributing, license). The top‑level README is now more concise and
intuitive, (with corrected screenshots).
It also consolidates overlapping content from codex-rs/README.md into
the top‑level docs and updates links accordingly. The codex-rs README
remains in place for now as a pointer and for continuity.
Finally, added an extensive config reference table at the bottom of
docs/config.md.
---------
Co-authored-by: easong-openai <easong@openai.com>
2025-08-27 10:30:39 -07:00
> [!TIP]
2025-11-11 14:45:40 +01:00
> LLMX often takes a few minutes to run. To accommodate this, adjust the MCP inspector's Request and Total timeouts to 600000ms (10 minutes) under ⛭ Configuration.
2025-09-11 14:38:24 -07:00
2025-11-11 14:45:40 +01:00
Use the MCP inspector and `llmx mcp-server` to build a simple tic-tac-toe game with the following settings:
2025-09-11 14:38:24 -07:00
**approval-policy:** never
2025-11-06 11:00:28 -06:00
**prompt:** Implement a simple tic-tac-toe game with HTML, JavaScript, and CSS. Write the game in a single file called index.html.
2025-09-11 14:38:24 -07:00
**sandbox:** workspace-write
2025-11-11 14:45:40 +01:00
Click "Run Tool" and you should see a list of events emitted from the LLMX MCP server as it builds the game.