Getting Started

Installation

Set up cruxOS on your system.

Requirements

  • Node.js 18+ (LTS recommended)
  • npm or pnpm

CLI Installation

# Using npm
npm install -g @cruxos/cli

# Using pnpm
pnpm add -g @cruxos/cli

# Verify installation
cruxos --version

Package Installation

For use in your own projects:

# Core packages
npm install @cruxos/ir @cruxos/vm

# With compiler
npm install @cruxos/lang

Development Setup

To contribute to cruxOS:

git clone https://github.com/cruxos/cruxos
cd cruxos
pnpm install
pnpm build
pnpm test