Skip to content

README.wsl2.md

Latest commit

 

History

History
47 lines (31 loc) · 1.79 KB

README.wsl2.md

File metadata and controls

47 lines (31 loc) · 1.79 KB
Raw

CCM for WSL2

Use this archive only inside a WSL2 distribution. It supports independent Linux Codex configuration or an explicit shared Windows Desktop Codex configuration, plus Pi and Grok Build channels managed inside WSL.

Requirements

  • A WSL2 distribution (WSL1 is not supported) with Node.js 22 or later.
  • Install the CLI(s) inside WSL that you plan to manage: codex, claude, pi, and/or grok.

Install modes

bash ./install.sh
Mode Codex home When to use it
independent WSL ~/.codex Keep WSL Codex data separate from Windows Desktop.
shared Windows %USERPROFILE%\.codex, mounted in WSL Share Codex configuration and login state with Windows Desktop.

For non-interactive installs:

bash ./install.sh --yes --wsl-mode independent
bash ./install.sh --yes --wsl-mode shared \
  --windows-codex-home /mnt/c/Users/<Windows-user>/.codex

Pi and Grok Build

Pi always uses its WSL configuration directory ~/.pi/agent. For official Pi access, CCM starts Pi and you complete /login interactively:

ccm --tool pi --login-official

Third-party Pi providers are saved in models.json; choose a protocol in the Pi tab: openai-completions, openai-responses, anthropic-messages, or google-generative-ai.

Grok Build always uses WSL ~/.grok/config.toml. Its official login uses device authorization automatically in WSL2:

ccm --tool grok --login-official

Third-party Grok channels require Base URL, API key, Model ID, and one backend: responses, chat_completions, or messages. Use ccm --ui to add channels and ccm --tool grok --use <channel-id-or-name> to switch them.

CCM does not share Pi or Grok credentials with Windows Desktop. It backs up their WSL configuration before each channel switch.