Installation

Get XibeCode up and running in under a minute. Install via npm, pnpm, or from source.

Get XibeCode up and running in under a minute.

Requirements

Node.js 18.0.0 or higher
An AI provider API key (Anthropic, OpenAI, or compatible)

Install from npm (Recommended)

pnpm add -g xibecode

Or use your preferred package manager:

# npm
npm install -g xibecode

# bun
bun add -g xibecode

Using xibecode-core as a Library

The AI engine is available as a standalone package:

pnpm add xibecode-core

import {
  EnhancedAgent,
  CodingToolExecutor,
  NeuralMemory,
  AutoMemoryManager,
  SettingsManager,
  HooksManager,
  PermissionRuleManager,
  HOOK_EVENTS,
  PROVIDER_CONFIGS,
} from 'xibecode-core';

This allows you to build custom AI coding tools, desktop apps, or extensions on top of the XibeCode engine.

Install from Source

git clone https://github.com/iotserver24/Xibecode
cd Xibecode
pnpm install
pnpm run build
pnpm link --global --dir packages/cli

Set up API Key

XibeCode needs an AI provider API key (Anthropic, OpenAI, or compatible). You can set it up in three ways:

Option 1: Interactive Setup (Recommended)

xibecode config

Option 2: Direct Configuration

# Set API key
xibecode config --set-key YOUR_ANTHROPIC_API_KEY

# Or for OpenAI
xibecode config --set-key YOUR_OPENAI_API_KEY

Option 3: Environment Variable

# Anthropic
export ANTHROPIC_API_KEY=your_key_here

# OpenAI
export OPENAI_API_KEY=your_key_here

# Google
export GOOGLE_API_KEY=your_key_here

# Groq
export GROQ_API_KEY=your_key_here

Verify Installation

# Check version
xibecode --version

# View current configuration
xibecode config --show

# Run a simple test
xibecode chat

Directory Structure

XibeCode creates the following directories:

~/.xibecode/           # Global configuration
  ├── config.json       # Main configuration file
  ├── settings.json     # User-level settings (permissions, hooks, memory config)
  ├── mcp-servers.json  # MCP server configurations
  └── backups/          # File backups

~/.xibecode/projects/  # Project-scoped data
  └── <sanitized-cwd>/ # Per-project directory
      ├── <session-id>.jsonl # Append-only session transcripts (primary format)
      ├── <session-id>.json  # Legacy format (backward compatibility)
      └── memory/            # Auto-extracted memory files

.xibecode/             # Project-level (in your working directory)
  ├── settings.json       # Project settings (committed, shared with team)
  ├── settings.local.json # Local settings (not committed, personal overrides)
  ├── memory.md           # Project memory notes
  └── skills/             # Custom skills for this project

Supported Platforms

macOS — Full support (Intel and Apple Silicon)
Linux — Full support (Ubuntu, Debian, Fedora, Arch)
Windows — Full support (PowerShell and WSL)

Troubleshooting

Permission Denied on Global Install

# Better: Fix npm permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

Node.js Version Too Old

# Using nvm (Node Version Manager)
nvm install 18
nvm use 18

Next Steps

Quick Start Guide — Run your first autonomous coding task
Configuration — Customize XibeCode for your workflow
Agent Modes — Learn about the 13 specialized agent personas
Settings — Multi-source layered configuration
Auto-Memory — Persistent project memory
Lifecycle Hooks — Run custom logic at agent events
Permissions — Control tool execution with rules