Installation

Use via CDN

The fastest way to start — no CLI, no download, no build step. Add an import map pointing to the Weblisk CDN and start writing modules immediately:

html

<script type="importmap">
{
  "imports": {
    "weblisk":  "https://cdn.weblisk.dev/weblisk.js",
    "weblisk/": "https://cdn.weblisk.dev/"
  }
}
</script>

That's it. Every module (core/hydrate.js, state/store.js, nav/router.js, etc.) is served from the edge — no installation required. When you're ready for local files or scaffolding, install the CLI below.

Install the CLI

A single command downloads the binary for your platform:

macOS / Linux

curl -fsSL https://cdn.weblisk.dev/install.sh | sh

Windows (PowerShell)

irm https://cdn.weblisk.dev/install.ps1 | iex

Or download the binary directly from GitHub Releases and place it anywhere in your PATH.

Create a New Project

bash

weblisk new my-app
cd my-app
open index.html

Or use any static file server to preview your site.

Using a Template

Weblisk includes starter templates for common project types:

bash

weblisk new my-blog --template blog
weblisk new my-dashboard --template dashboard
weblisk new my-docs --template docs
weblisk new my-site --template starter

Adding to an Existing Project

Use the CDN import map above, or vendor the framework files locally with the CLI:

bash

# Download all framework modules into lib/weblisk/
weblisk vendor

# Or specify a custom destination
weblisk vendor --dest src/lib/weblisk

Then point your import map at the local files:

html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>My App</title>
  <script type="importmap">
  {
    "imports": {
      "weblisk":  "/lib/weblisk/weblisk.js",
      "weblisk/": "/lib/weblisk/"
    }
  }
  </script>
</head>
<body>
  <!-- your content -->
  <script type="module">
  import { hydrateIslands } from 'weblisk/core/hydrate.js';
  hydrateIslands();
  </script>
</body>
</html>

That's it — no build step, no configuration file, no route manifest. Your HTML is the source of truth.

Requirements

None. The CLI is a single static binary — no runtime, no package manager, no dependencies
No Node.js needed for the framework itself — it runs natively in the browser

What Gets Installed

A single binary at ~/.weblisk/bin/weblisk. That's it. No global packages, no node_modules, no lock files. The browser framework uses only native Web APIs.