Skip to main content

Glimx Installation Guide

This guide covers all the ways to install Glimx CLI on your system.

Prerequisites​

Before installing Glimx, ensure you have:

  • Node.js (v18 or higher) or Bun (v1.0 or higher)
  • Git (for version control features)
  • curl or wget (for quick install script)

The fastest way to install Glimx is using our one-line install script:

curl -fsSL https://codelabs-poliwangi.github.io/glimx-cli/install.sh | bash

Or using wget:

wget -qO- https://codelabs-poliwangi.github.io/glimx-cli/install.sh | bash

This script will:

  1. Detect your operating system and architecture
  2. Download the appropriate binary from the latest GitHub release
  3. Install it to /usr/local/bin/glimx (may require sudo)
  4. Verify the installation

Package Manager Installation​

npm (Node.js)​

npm install -g glimx

Bun​

bun install -g glimx

pnpm​

pnpm install -g glimx

Yarn​

yarn global add glimx

Manual Installation​

Download Pre-built Binaries​

  1. Visit the GitHub Releases page
  2. Download the appropriate binary for your platform
  3. Extract and move to a directory in your PATH

Build from Source​

# Clone the repository
git clone https://github.com/codelabs-poliwangi/glimx-cli.git
cd glimx-cli

# Install dependencies
bun install

# Build the project
cd packages/opencode
bun run build

# Link globally
bun link

Platform-specific Instructions​

macOS​

On macOS, you can also use Homebrew (once available):

brew install glimx

Linux​

For Linux distributions with systemd, you can enable shell completions:

# After installation, enable completions
glimx --setup-completions

Windows​

On Windows, you can use PowerShell with the quick install script:

irm https://codelabs-poliwangi.github.io/glimx-cli/install.sh | iex

Or install via npm/bun in WSL (Windows Subsystem for Linux).

Verification​

After installation, verify Glimx is working:

glimx --version
glimx --help

Post-installation Setup​

Configure Free Models​

To use free AI models, get API keys from:

  1. Groq (recommended): https://console.groq.com/keys
  2. OpenRouter: https://openrouter.ai/keys
  3. Cerebras: https://cloud.cerebras.ai/console

Then set them in your environment:

export GROQ_API_KEY="your-groq-key-here"
export OPENROUTER_API_KEY="your-openrouter-key-here"
export CEREBRAS_API_KEY="your-cerebras-key-here"

Add these to your shell profile (~/.bashrc, ~/.zshrc, etc.) for persistence.

First Run​

Start Glimx with a free model:

glimx --model groq/qwen-32b

Or run in interactive mode:

glimx

Troubleshooting​

Permission Issues​

If you encounter permission errors during installation:

# Try with sudo for system-wide installation
sudo npm install -g glimx

Path Issues​

If the glimx command is not found, ensure the installation directory is in your PATH:

# Check current PATH
echo $PATH

# Add to PATH if needed (adjust path as necessary)
export PATH="$PATH:/usr/local/bin"

Dependency Issues​

If you encounter dependency issues when building from source:

# Ensure you're using the correct Node.js version
node --version

# Clear npm cache
npm cache clean --force

# Reinstall dependencies
rm -rf node_modules package-lock.json
npm install

Updating​

To update Glimx:

If installed via package manager​

npm update -g glimx
# or
bun update -g glimx

If installed via quick install script​

glimx --update

If built from source​

cd glimx-cli
git pull
bun install
cd packages/opencode
bun run build

Uninstalling​

If installed via npm/bun​

npm uninstall -g glimx
# or
bun remove -g glimx

If installed via quick install script​

# Remove the binary
sudo rm /usr/local/bin/glimx

# Remove config directory (optional)
rm -rf ~/.opencode

Next Steps​

After installation, check out these resources: