Quickstart

Installing and running openClipar

Install openClipar via npm:

npm install -g openclipar

Then simply run openclipar to get started.

Note: The -g flag is required. npm i openclipar (without -g) installs the package locally into ./node_modules and does not put the openclipar command on your PATH, which results in command not found.

You can also build openClipar from source. See Installing & building for the full toolchain setup, then:

git clone https://github.com/anguzuDaniel/openClipar.git
cd openClipar/codex-rs
cargo build
cargo run --bin codex -- "explain this codebase to me"

The compiled binary is named codex internally; the published npm package exposes it as the openclipar command.

Updating openClipar

Update to the latest release with the same package manager you installed with:

npm install -g openclipar@latest
# or
bun install -g openclipar@latest
# or
pnpm add -g openclipar@latest

You can check your current version and whether an update is available with:

openclipar --version
openclipar doctor

If you built from source, pull the latest changes and rebuild instead:

cd openClipar
git pull
cd codex-rs
cargo build --release

Configuration

openClipar reads its configuration from ~/.codex for compatibility with existing Codex setups. See the configuration docs for available options.

Troubleshooting

command not found: openclipar after installing

1. Make sure you installed globally with npm install -g openclipar (a plain npm i openclipar only installs locally and won't add the command to your PATH).

2. Confirm npm's global bin directory is on your PATH:

   npm prefix -g        # global install prefix
   which openclipar     # should print a path once installed globally

   The openclipar symlink is placed in <prefix>/bin. On an Intel Mac with Homebrew node this is typically /usr/local/bin; on Apple Silicon it's /opt/homebrew/bin. If that directory isn't on your PATH, add it to your shell profile (e.g. ~/.zshrc).

If you instead see a Missing optional dependency openclipar-<platform> error, reinstall with npm install -g openclipar@latest so the native binary for your platform is fetched.

Docs

• Contributing
• Installing & building

Relationship to OpenAI Codex

openClipar is a community-maintained fork and is not affiliated with, endorsed by, or supported by OpenAI. It tracks the upstream openai/codex project while adapting user-facing branding, packaging, and release infrastructure for independent distribution.

This repository is licensed under the Apache-2.0 License.