Install and Update Wayland Core

Wayland Core is published to npm as @ferroxlabs/wayland-core. The package is a small launcher plus per-platform binary packages, so npm installs only the binary that matches your machine. The command it installs is wayland-core.

Install with npm

Global install:

npm i -g @ferroxlabs/wayland-core

Run once without a global install:

npx @ferroxlabs/wayland-core "Read Cargo.toml and explain the dependencies"

Confirm it is on your PATH:

wayland-core --version

Build from source

If you have a Rust toolchain and want to build it yourself, clone the repository and build the release binary:

cargo build --release
# the binary lands at ./target/release/wayland-core

First-time setup

Generate a default config, then point yourself at where it lives:

wayland-core --init-config     # write a default config file
wayland-core --config-path     # print where that file lives

Edit the generated config to add a provider and key, or sign in to an Anthropic account with OAuth instead of pasting a key:

wayland-core --login           # OAuth device flow, no API key needed
wayland-core --logout          # remove saved OAuth credentials

See Configuration for the full config format and Providers and Auth for per-provider setup.

Keep it current

The engine updates itself from its signed release feed:

wayland-core self-update                # update to the latest signed release
wayland-core self-update --check-only   # print current vs. latest, do not install

self-update verifies the release signature (ed25519) against a pinned key before swapping the binary in place, so an update only proceeds if it is authentic.

The bundled copy

If you only use the desktop app, you do not need this install at all: the app carries its own matching wayland-core binary and prepares it on first run. Install the standalone CLI when you also want the engine on your PATH for scripts, CI, or headless use.