Agent IDE — Codex fork for AI-native development environment
Find a file
pchuri 44dce748b6
feat: add Android/Termux support by gating arboard dependency (#2895)
## Summary

This PR enables Codex to build and run on Android/Termux environments by
conditionally gating the arboard clipboard dependency for Android
targets.

## Key Changes

- **Android Compatibility**: Gate arboard dependency for Android targets
where clipboard access may be restricted
- **Build Fixes**: Add missing tempfile::Builder import for image
clipboard operations
- **Code Cleanup**: Remove unnecessary parentheses to resolve formatting
warnings

## Technical Details

### Clipboard Dependency Gating
- Uses conditional compilation to exclude arboard on Android targets
- Maintains full clipboard functionality on other platforms
- Prevents build failures on Android/Termux where system clipboard
access is limited

### Import Fixes
- Adds missing tempfile::Builder import that was causing compilation
errors
- Ensures image clipboard operations work correctly when clipboard is
available

## Platform Support

-  **Linux/macOS/Windows**: Full clipboard functionality maintained
-  **Android/Termux**: Builds successfully without clipboard dependency
-  **Other Unix platforms**: Unchanged behavior

## Testing

-  Builds successfully on Android/Termux
-  Maintains clipboard functionality on supported platforms  
-  No regression in existing functionality

This addresses the Android/Termux compatibility issues while keeping
clipboard functionality intact for platforms that support it.
2025-09-02 23:36:40 -07:00
.devcontainer chore: install an extension for TOML syntax highlighting in the devcontainer (#1650) 2025-07-22 10:58:09 -07:00
.github fix: install zstd on the windows-11-arm image used to cut a release (#3066) 2025-09-02 14:23:51 -07:00
.vscode Added launch profile for attaching to a running codex CLI process (#2372) 2025-08-15 23:35:01 -07:00
codex-cli fix: include arm64 Windows executable in npm module (#3067) 2025-09-02 15:43:42 -07:00
codex-rs feat: add Android/Termux support by gating arboard dependency (#2895) 2025-09-02 23:36:40 -07:00
docs docs: fix typo of config.md (#3082) 2025-09-02 23:14:57 -07:00
scripts README / docs refactor (#2724) 2025-08-27 10:30:39 -07:00
.codespellignore feat: make it possible to toggle mouse mode in the Rust TUI (#971) 2025-05-16 16:16:50 -07:00
.codespellrc Re-add markdown streaming (#2029) 2025-08-12 17:37:28 -07:00
.gitignore restructure flake for codex-rs (#888) 2025-05-13 13:08:42 -07:00
.npmrc chore: migrate to pnpm for improved monorepo management (#287) 2025-04-18 16:25:15 -07:00
.prettierignore [apply-patch] Clean up apply-patch tool definitions (#2539) 2025-08-21 20:07:41 -07:00
.prettierrc.toml Initial commit 2025-04-16 12:56:08 -04:00
AGENTS.md prefer ratatui Stylized for constructing lines/spans (#3068) 2025-09-02 23:19:54 +00:00
CHANGELOG.md Point the CHANGELOG to the releases page (#2780) 2025-08-27 11:45:40 -07:00
cliff.toml bump(version): 0.1.2504251709 (#660) 2025-04-25 17:15:40 -07:00
flake.lock restructure flake for codex-rs (#888) 2025-05-13 13:08:42 -07:00
flake.nix restructure flake for codex-rs (#888) 2025-05-13 13:08:42 -07:00
LICENSE Initial commit 2025-04-16 12:56:08 -04:00
NOTICE resizable viewport (#1732) 2025-07-31 00:06:55 +00:00
package.json [codex-cli] Add ripgrep as a dependency for node environment (#2237) 2025-08-13 13:49:27 -07:00
pnpm-lock.yaml chore: remove the TypeScript code from the repository (#2048) 2025-08-08 16:09:39 -07:00
pnpm-workspace.yaml chore: remove the TypeScript code from the repository (#2048) 2025-08-08 16:09:39 -07:00
PNPM.md fix: include pnpm lock file (#377) 2025-04-18 17:01:11 -07:00
README.md Bugfix: Prevents brew install codex in comment to be executed (#2868) 2025-08-28 21:40:28 -07:00

OpenAI Codex CLI

npm i -g @openai/codex
or brew install codex

Codex CLI is a coding agent from OpenAI that runs locally on your computer.
If you are looking for the cloud-based agent from OpenAI, Codex Web, see chatgpt.com/codex.

Codex CLI splash


Quickstart

Installing and running Codex CLI

Install globally with your preferred package manager. If you use npm:

npm install -g @openai/codex

Alternatively, if you use Homebrew:

brew install codex

Then simply run codex to get started:

codex
You can also go to the latest GitHub Release and download the appropriate binary for your platform.

Each GitHub Release contains many executables, but in practice, you likely want one of these:

  • macOS
    • Apple Silicon/arm64: codex-aarch64-apple-darwin.tar.gz
    • x86_64 (older Mac hardware): codex-x86_64-apple-darwin.tar.gz
  • Linux
    • x86_64: codex-x86_64-unknown-linux-musl.tar.gz
    • arm64: codex-aarch64-unknown-linux-musl.tar.gz

Each archive contains a single entry with the platform baked into the name (e.g., codex-x86_64-unknown-linux-musl), so you likely want to rename it to codex after extracting it.

Using Codex with your ChatGPT plan

Codex CLI login

Run codex and select Sign in with ChatGPT. We recommend signing into your ChatGPT account to use Codex as part of your Plus, Pro, Team, Edu, or Enterprise plan. Learn more about what's included in your ChatGPT plan.

You can also use Codex with an API key, but this requires additional setup. If you previously used an API key for usage-based billing, see the migration steps. If you're having trouble with login, please comment on this issue.

Model Context Protocol (MCP)

Codex CLI supports MCP servers. Enable by adding an mcp_servers section to your ~/.codex/config.toml.

Configuration

Codex CLI supports a rich set of configuration options, with preferences stored in ~/.codex/config.toml. For full configuration options, see Configuration.


Docs & FAQ


License

This repository is licensed under the Apache-2.0 License.