Skip to content

install.md

Latest commit

 

History

History
88 lines (64 loc) · 3.44 KB

install.md

File metadata and controls

88 lines (64 loc) · 3.44 KB
Raw

Installing and Building Codez

Codez is published here as a source projection with release archives for Linux x64 and Windows x64 on the Codez releases page.

The release archives include a short README and installer script. Verify the downloaded archive against the release SHA256SUMS file before installing.

System Requirements

Requirement Details
Operating systems macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 via WSL2
Git (optional, recommended) 2.23+ for built-in PR helpers
RAM 4-GB minimum (8-GB recommended)

Build from Source

Clone the Codez public source tree and build the Rust workspace:

git clone https://github.com/Krablante/codez.git
cd codez/codex-rs

# Install the Rust toolchain, if necessary.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
source "$HOME/.cargo/env"
rustup component add rustfmt
rustup component add clippy
# Install helper tools used by the workspace justfile:
cargo install --locked just
# Optional: install nextest for the `just test` helper
cargo install --locked cargo-nextest

# Build Codez.
cargo build

# Launch the TUI with a sample prompt.
cargo run --bin codex -- "explain this codebase to me"

# After making changes, use the root justfile helpers (they default to codex-rs):
just fmt
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 test suite via nextest:
just test
# Avoid `--all-features` for routine local runs because it increases build
# time and `target/` disk usage by compiling additional feature combinations.
# If you specifically want full feature coverage, use:
cargo test --all-features

App Server v2 Path

Codez App Server v2 is the primary runtime surface for gateway integrations such as Teledex full mode. Build the same workspace, then use the codex app-server command:

cd codez/codex-rs
cargo run --bin codex -- app-server --listen stdio://

For protocol details, transports, auth modes, and JSON-RPC lifecycle, see codex-rs/app-server/README.md.

Upstream Package Compatibility

Upstream package names such as @openai/codex remain relevant for compatibility with inherited Codex docs and tooling. They are not Codez release artifacts for this repository.

Tracing / verbose logging

Codex is written in Rust, so it honors the RUST_LOG environment variable to configure its logging behavior.

The TUI defaults to RUST_LOG=codex_core=info,codex_tui=info,codex_rmcp_client=info and log messages are written to ~/.codex/log/codex-tui.log by default. For a single run, you can override the log directory with -c log_dir=... (for example, -c log_dir=./.codex-log).

tail -F ~/.codex/log/codex-tui.log

By comparison, the non-interactive mode (codex exec) defaults to RUST_LOG=error, but messages are printed inline, so there is no need to monitor a separate file.

See the Rust documentation on RUST_LOG for more information on the configuration options.