cd-pika-install

One-command installer for OpenAI Codex CLI with automatic Pikkapi configuration.

Before You Start

You need Node.js and Git installed on your computer first. If you've never installed them before, follow the full walkthrough in PREREQUISITES.md (5 minutes, beginner-friendly with screenshots-worth-of-detail).

Quick check — open a terminal (Command Prompt on Windows, Terminal on Mac) and run:

node -v
git --version

If both commands print a version number (e.g. v20.11.1 and git version 2.43.0), you're ready. If either says "not recognized" or "command not found", go to PREREQUISITES.md first.

TL;DR for those in a hurry:

1. Install Node.js LTS from https://nodejs.org (just click Next-Next-Finish)
2. Install Git from https://git-scm.com/downloads (same — Next-Next-Finish)
3. Restart your terminal, then continue to Quick Start below.

Quick Start

Make sure you've completed Before You Start — node -v and git --version should both work.

Recommended (Node.js + Git already installed)

npx cd-pika-install

On Linux/macOS, you may need sudo:

sudo npx cd-pika-install

Fallback (auto-installs Node.js + Git if missing)

Use this if you skipped the prerequisites and want the setup script to install everything for you.

Linux/macOS:

curl -fsSL https://raw.githubusercontent.com/kktvg001-dot/cd-pika-install/main/setup.sh | bash

Windows: Open PowerShell as Administrator and run:

Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/kktvg001-dot/cd-pika-install/main/setup.bat' -OutFile "$env:TEMP\setup.bat"; Start-Process "$env:TEMP\setup.bat" -Verb RunAs

Note: the fallback path is less reliable on macOS (it requires Homebrew) and may need a terminal restart on Windows. The manual prerequisites route is more robust.

What It Does

This installer automates the entire Codex setup process:

1. ✅ Installs Codex CLI globally via npm (@openai/codex)
2. ✅ Prompts you for your API Key
3. ✅ Creates ~/.codex/config.toml with model + provider settings
4. ✅ Creates ~/.codex/auth.json with your API key
5. ✅ Ready to run with codex

After installation completes, simply run codex to start.

Requirements

• Node.js 18 or newer - Download here
• npm (comes with Node.js)
• sudo access (on Linux/macOS for global installation)

Step-by-Step Usage

1. Run the installer:

   npx cd-pika-install

2. Enter your API Key when prompted:

   Enter your API key: sk-your-api-key-here

3. Wait for installation to complete:

   Installing Codex CLI via npm...
   Configuring Codex...
   ✅ Installation complete!

4. Start using Codex:

   codex

Configuration

The installer creates two files under ~/.codex/:

config.toml — core Codex configuration:

model_provider = "codextest"
model = "gpt-5.5"
model_reasoning_effort = "high"
sandbox_mode = "danger-full-access"
approval_policy = "never"
network_access = "enabled"
disable_response_storage = true
windows_wsl_setup_acknowledged = true
model_verbosity = "high"

[windows]
sandbox = "unelevated"

[projects.'<your home dir>']
trust_level = "trusted"

[model_providers.codextest]
name = "codextest"
base_url = "https://pikkapi.cooltechgp.online/v1"
wire_api = "responses"
requires_openai_auth = true

auth.json — API key:

{
  "OPENAI_API_KEY": "your-key-here"
}

Where to find your key: in the proxy token management page, copy the token from the Codex group and paste it when prompted.

Manual Installation (Reference)

If you prefer to install everything by hand instead of using this installer:

1. Install Codex CLI:

   npm install -g @openai/codex

2. Open your Codex config directory:

   • Windows: press Win+R, enter %userprofile%\.codex, press Enter
   • macOS / Linux: ~/.codex (create it if missing: mkdir -p ~/.codex)

3. Create config.toml with the configuration block shown above.

4. Create auth.json with your API key.

5. Test:

   codex

   If the chat interface appears, you're good to go.

Uninstallation

One-liner (recommended):

npx cd-pika-uninstall

On Linux/macOS you may need sudo:

sudo npx cd-pika-uninstall

This removes the Codex CLI (@openai/codex) and the ~/.codex config directory. Node.js and Git are kept.

Troubleshooting

Permission denied error:

• Use sudo npx cd-pika-install on Linux/macOS
• Run as Administrator on Windows

Node.js not found:

• Install Node.js 18+ from https://nodejs.org/

codex not recognized after install:

• Restart your terminal so the new PATH takes effect.

License

MIT