mirror of
https://github.com/openai/codex.git
synced 2026-02-01 14:44:17 +00:00
chore: update outdated docs (#8701)
This commit is contained in:
committed by
GitHub
parent
1b5095b5d1
commit
ee9d441777
@@ -15,8 +15,8 @@ You can also install via Homebrew (`brew install --cask codex`) or download a pl
|
||||
|
||||
## Documentation quickstart
|
||||
|
||||
- First run with Codex? Follow the walkthrough in [`docs/getting-started.md`](../docs/getting-started.md) for prompts, keyboard shortcuts, and session management.
|
||||
- Already shipping with Codex and want deeper control? Jump to [`docs/advanced.md`](../docs/advanced.md) and the configuration reference at [`docs/config.md`](../docs/config.md).
|
||||
- First run with Codex? Start with [`docs/getting-started.md`](../docs/getting-started.md) (links to the walkthrough for prompts, keyboard shortcuts, and session management).
|
||||
- Want deeper control? See [`docs/config.md`](../docs/config.md) and [`docs/install.md`](../docs/install.md).
|
||||
|
||||
## What's new in the Rust CLI
|
||||
|
||||
@@ -30,7 +30,7 @@ Codex supports a rich set of configuration options. Note that the Rust CLI uses
|
||||
|
||||
#### MCP client
|
||||
|
||||
Codex CLI functions as an MCP client that allows the Codex CLI and IDE extension to connect to MCP servers on startup. See the [`configuration documentation`](../docs/config.md#mcp_servers) for details.
|
||||
Codex CLI functions as an MCP client that allows the Codex CLI and IDE extension to connect to MCP servers on startup. See the [`configuration documentation`](../docs/config.md#connecting-to-mcp-servers) for details.
|
||||
|
||||
#### MCP server (experimental)
|
||||
|
||||
|
||||
@@ -5,3 +5,15 @@ For basic configuration instructions, see [this documentation](https://developer
|
||||
For advanced configuration instructions, see [this documentation](https://developers.openai.com/codex/config-advanced).
|
||||
|
||||
For a full configuration reference, see [this documentation](https://developers.openai.com/codex/config-reference).
|
||||
|
||||
## Connecting to MCP servers
|
||||
|
||||
Codex can connect to MCP servers configured in `~/.codex/config.toml`. See the configuration reference for the latest MCP server options:
|
||||
|
||||
- https://developers.openai.com/codex/config-reference
|
||||
|
||||
## Notify
|
||||
|
||||
Codex can run a notification hook when the agent finishes a turn. See the configuration reference for the latest notification settings:
|
||||
|
||||
- https://developers.openai.com/codex/config-reference
|
||||
|
||||
@@ -26,7 +26,7 @@ rustup component add rustfmt
|
||||
rustup component add clippy
|
||||
# Install helper tools used by the workspace justfile:
|
||||
cargo install just
|
||||
# Optional: install nextest for the `just test` helper (or use `cargo test --all-features` as a fallback)
|
||||
# Optional: install nextest for the `just test` helper
|
||||
cargo install cargo-nextest
|
||||
|
||||
# Build Codex.
|
||||
@@ -41,9 +41,9 @@ just fix -p <crate-you-touched>
|
||||
|
||||
# Run the relevant tests (project-specific is fastest), for example:
|
||||
cargo test -p codex-tui
|
||||
# If you have cargo-nextest installed, `just test` runs the full suite:
|
||||
# If you have cargo-nextest installed, `just test` runs the test suite via nextest:
|
||||
just test
|
||||
# Otherwise, fall back to:
|
||||
# If you specifically want the full `--all-features` matrix, use:
|
||||
cargo test --all-features
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user