ARKlight logoARKlight
Getting startedTutorialReferenceExamplesWhyChangelog

Reference

Reference overview
Components
Actions
CLI
Gotchas
Experimental APIs

CLI

One command, eight subcommands.

Command

What it does

arklight build

Compile a site file to static HTML and CSS.

arklight pack

Pack a build directory into a single .ark bundle (sealed by default).

arklight unpack

Extract a .ark bundle's archive half back into a build directory.

arklight pwa

Turn a build directory into an installable PWA (manifest and service worker).

arklight deploy

Build, then deploy with the hosting provider's own CLI (Cloudflare Workers via Wrangler).

arklight new

Scaffold a new project from a built-in template.

arklight search

Look up a component's schema by name, with typo-tolerant suggestions.

arklight live-streaming

Dev-only: auto-rebuild and browser auto-reload on file change.

build

arklight build site.py -o ARK --no-open

Flag

Meaning

-o, --output

Output directory (default: ARK).

--open / --no-open

Open the built site in your browser (default is to open).

-v, --verbose

Print each compiler pipeline stage.

--debug

Like --verbose, plus the full traceback on failure.

--narrate

Like --verbose, narrated in sentences by Rei, the compiler narrator.

--max-width, --bg, --font-family, --lang, --button-text

Override site-wide options without editing the site file.

--emit-arklight

Emit a binary IR snapshot that a later build can start from.

Non-interactive use

In CI or scripts, set

ARKLIGHT_ACCEPT_LICENSE=1

, or

arklight

refuses to run. See the

license summary

.

Looking things up

arklight search Picture
arklight search Action.increment

Prints required props, child rules, and arguments straight from the installed compiler.

LicenseChangelogGitHubPyPI

ARKlight is GPLv3 with attribution terms; sites you build are yours. Your browser is still running JavaScript. We just made Python responsible for getting it there.