Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting started

Install

Prebuilt binaries for Linux, macOS and Windows are on GitHub Releases. The install scripts download the latest one, verify its SHA-256 and put it into ~/.vard/bin:

curl -fsSL https://raw.githubusercontent.com/vardemin/vardui/master/install.sh | sh
irm https://raw.githubusercontent.com/vardemin/vardui/master/install.ps1 | iex

From source (Rust 1.98, pinned in rust-toolchain.toml; rustup fetches it automatically):

git clone https://github.com/vardemin/vardui.git
cd vardui
cargo build --release

The binary is vard (target/release/vard from source). Everything a person or an agent needs — compiler, headless runtime, test runner, reference, package manager, registry server and MCP server — is in this one file.

First project

vard new hello
hello/
  app.vard              the root view App
  vard.toml             manifest: app name, dependencies, policy
  tests/smoke.vtest     a scripted test
  AGENTS.md, CLAUDE.md  instructions for agents (the package list block updates itself)
  .mcp.json             the `vard mcp` server for Claude Code and other clients
  .claude/skills/       skills vard-app, vard-debug, vard-native, vard-design, vard-packages

app.vard:

view App {
  state count = 0

  Column(padding: 24, gap: 16, justify: .center, align: .center, grow: 1) {
    Text("Hello, Vard", style: .title)
    Text("Tapped {count} times", color: .muted)
    Button("Tap me", onTap: { count += 1 })
  }
}

The development loop

The same for a person and for an agent; every step takes milliseconds and is deterministic.

cd hello
vard check --fix          # types + machine fixes
vard run                  # the screen as text (semantic tree)
vard run --do 'tap "Tap me"; expect "Tapped 1 times"'
vard test                 # every tests/*.vtest

vard run prints the screen as a tree with ids:

> tree
screen 390x844 light
App @1
  Text "Hello, Vard" @2
  Text "Tapped 0 times" @3
  Button "Tap me" @4

A mutating action prints only what changed:

> tap "Tap me"
~ Text "Tapped 1 times" @3

A compile error is a location, the line of code and a fix:

app.vard:2:3 error E0201: unknown element `VStack`
  2 | VStack(gap: 8) {
  fix: `VStack` -> `Column` (auto: vard check --fix)

Add a package

vard search tailwind
vard add tailwind
vard doc tailwind          # the package's AGENT.md + the API generated by the compiler

After vard add the package’s public names are visible without imports: TwButton("Save", onTap: save). More in Using packages.

Run on Android

cd platforms/android
./gradlew installDebug -Pvard.app=examples/todo

You need the Android SDK/NDK and cargo-ndk — see Android shell. The build bundles the app and its packages (vard bundle) and includes the packages’ native modules by itself.

Next