Installation

The fastest way to get started with Hypen is using the CLI.

Install the CLI

# Using Bun (recommended)
bun install -g @hypen-space/cli

# Using npm
npm install -g @hypen-space/cli

Create a New Project

hypen init my-app
cd my-app

This creates a new Hypen project with:

• A starter component
• TypeScript configuration
• Development server setup

Start Development Server

hypen dev

This starts a hot-reloading development server at http://localhost:3000.

Project Structure

The CLI creates this structure:

my-app/
├── src/
│   ├── components/
│   │   └── App/
│   │       ├── component.hypen    # UI template
│   │       └── component.ts       # Module logic
│   └── main.ts                    # Entry point
├── public/
│   └── index.html
├── package.json
└── tsconfig.json

CLI Commands

Manual Setup (Alternative)

If you prefer to set up manually:

Web

mkdir my-hypen-app
cd my-hypen-app
npm init -y
npm install @hypen-space/core @hypen-space/web

See the Web Adapter docs for detailed web setup.

Android

Add to your build.gradle.kts:

dependencies {
    implementation("space.hypen:hypen-android:0.1.0")
}

See the Android Adapter docs for detailed Android setup.

iOS

See the iOS Adapter docs for iOS setup.

Requirements

• Node.js 18+ or Bun 1.0+
• Modern browser with WASM support (Chrome, Firefox, Safari, Edge)

IDE Setup

For the best development experience, install the Hypen Language Server:

VS Code / Cursor

1. Download the .vsix from releases
2. Extensions → Install from VSIX
3. Select the file and reload

See LSP Documentation for more details.

Verify Installation

hypen --version

You should see the version number printed.

Next Steps

• Your First App - Build a counter app step by step
• Basics Guide - Learn the Hypen syntax