Skip to content

Search titles, headings, and documentation content.

↑↓ navigate Enter open Esc close

    Browse documentation
    On this page

    Development server

    Run this from the directory containing sklair.json:

    sklair serve

    Sklair builds the project into a temporary directory, serves it locally, and watches the source, component, and layout directories. Connected pages refresh after a successful rebuild.

    The development build contains a small reload client. A normal sklair build does not include it of course.

    Choose the address

    Use --port to request a port and --host to change the listening address:

    sklair serve --host 0.0.0.0 --port 1234
    Flag Default Purpose
    --host localhost Address on which the server listens.
    --port 0 Requested port. Zero chooses an available port.
    --auto-refresh true Refresh connected pages after successful rebuilds.
    --open false Open the preview in your default browser after the first successful build.
    --watch true Watch project files and rebuild when they change.

    Boolean values use Sklair's ordinary flag syntax:

    sklair serve --auto-refresh=false

    Use --watch=false to serve a single build without watching files. --auto-refresh=false keeps rebuilding while leaving connected pages alone. Press Ctrl+C to stop the server and remove its temporary output.

    SPA path rewrites

    To make development of single-page applications (SPAs) easier with Sklair, the development server allows the rewriting of certain paths into one entry document (e.g. /album/42 -> /album/index.html). This allows you to directly open or refresh those URLs during development.

    It is configured through serve.rewrites in sklair.json:

    {
  "serve": {
    "rewrites": [
      { "from": "/album/:id", "to": "/index.html" },
      { "from": "/player/*", "to": "/index.html" }
    ]
  }
}

    from matches the request path without its query string:

    Pattern Matches
    /about Exactly /about
    /album/:id One non-empty segment after /album/, such as /album/42
    /player/* /player and any path beneath it
    /* Every request path

    Named segments match a value but do not substitute it into to. The target is one fixed file relative to the output root, written with a leading slash. Use forward slashes on every operating system.

    Existing output files, including directory index files, take precedence. Otherwise, Sklair checks rules in their configured order and uses the first match for GET and HEAD requests. An absent target falls through to the usual 404 handling; later rules are not tried. The browser keeps the requested route while receiving the target document.

    Patterns must be clean paths beginning with /. Named segments contain letters, digits, or underscores; * is allowed only as the final segment. Duplicate patterns and invalid targets fail before the server starts. Trailing slashes are significant: /album/:id does not match /album/42/.