Skip to main content

Glimx Documentation

Welcome to Glimx documentation! 📚

What is Glimx?​

Glimx is an AI-powered terminal coding agent built on OpenCode's architecture with enhanced features:

  • 🆓 Free AI Models - Qwen, DeepSeek, Mistral via OpenRouter, Groq, Cerebras
  • 🔌 5 Default MCP Servers - Filesystem, Git, Sequential Thinking, Fetch, Memory
  • 🧠 Sequential Thinking - Step-by-step problem solving
  • 🔒 Smart Permissions - Command validation and approval
  • 💾 Memory System - Context persistence across sessions

Installation​

Quick Install​

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

Package Managers​

npm install -g glimx    # or bun/pnpm/yarn

Getting Started​

1. Get Free API Keys​

2. Configure Environment​

export GROQ_API_KEY="your-key-here"
export OPENROUTER_API_KEY="your-key-here"

3. Run Glimx​

# With free model
glimx --model groq/qwen-32b

# Interactive mode
glimx

Features​

MCP Servers (Auto-enabled)​

Glimx includes 5 MCP servers by default:

  1. filesystem - File system access
  2. git - Git operations
  3. sequential-thinking - Step-by-step reasoning
  4. fetch - Web content fetching
  5. memory - Knowledge graph persistence

Commands​

  • /compact - Summarize session to reduce tokens
  • /undo - Undo last message
  • /redo - Redo last message
  • /help - Show help

Permissions​

Default permission policy (configurable):

{
  "bash": {
    "git push *": "ask",
    "rm *": "ask",
    "chmod *": "ask",
    "*": "ask"
  },
  "edit": "ask",
  "write": "ask"
}

Three levels:

  • allow - Auto-execute
  • ask - Require approval
  • deny - Block

Workspace Templates​

Quick start with pre-configured projects:

  • node-typescript - Node.js + TypeScript + ESLint
  • react-vite - React + Vite + TailwindCSS
  • python-fastapi - FastAPI + Poetry

Configuration​

Edit ~/.opencode/config.json:

{
  "model": "groq/qwen-32b",
  "theme": "glimx",
  "permission": {
    "bash": {
      "git push *": "ask"
    }
  },
  "mcp": {
    "filesystem": {
      "type": "local",
      "command": ["npx", "-y", "@modelcontextprotocol/server-filesystem", "~"],
      "enabled": true
    }
  }
}

Troubleshooting​

Permission Denied​

# Make sure install script is executable
chmod +x docs/install.sh

API Key Issues​

# Verify keys are set
echo $GROQ_API_KEY
echo $OPENROUTER_API_KEY

Model Not Found​

Check available models:

Contributing​

Contributions are welcome! See CONTRIBUTING.md

Support​

License​

MIT License - see LICENSE