miru-cli
v0.1.0
Published
<p align="center"> <code>npm i -g miru-cli</code><br /> or <code>brew install --cask miru</code><br /> <sub>Legacy package: <code>@openai/codex</code></sub> </p>
Readme
[!NOTE] This repository recently renamed Codex CLI to Miru CLI. Most file paths and configuration directories still use the
codexprefix for compatibility; treat any remaining “Codex†references in this documentation as referring to miru.
Quickstart
Installing and running Miru CLI
Install globally with your preferred package manager. If you use npm:
npm install -g miru-cliAlternatively, if you use Homebrew:
brew install --cask miruThen simply run miru to get started:
miruIf you're running into upgrade issues with Homebrew, see the FAQ entry on brew upgrade miru.
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
- Apple Silicon/arm64:
- Linux
- x86_64:
codex-x86_64-unknown-linux-musl.tar.gz - arm64:
codex-aarch64-unknown-linux-musl.tar.gz
- x86_64:
Each archive contains a single entry with the platform baked into the name (e.g., miru-x86_64-unknown-linux-musl), so you likely want to rename it to miru after extracting it.
Using Codex with your ChatGPT plan
Run miru and select Sign in with ChatGPT. We recommend signing into your ChatGPT account to use miru 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 miru 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)
miru can access MCP servers. To configure them, refer to the config docs.
Configuration
Miru CLI supports a rich set of configuration options. Preferences currently reuse the Codex path at ~/.codex/config.toml for backward compatibility. For full configuration options, see Configuration.
Docs & FAQ
- Getting started
- Configuration
- Sandbox & approvals
- Authentication
- Automating Codex
- Advanced
- Zero data retention (ZDR)
- Contributing
- Install & build
- FAQ
- Open source fund
License
This repository is licensed under the Apache-2.0 License.
