Installation

There are two things you might install, depending on where you want the agent to run: the CLI for your terminal, or the SDK for your app. You can use either or both.

Install the CLI

The CLI ships as a self-contained native binary. The installers download it, verify its published checksum, and cache it under ~/.lily/. No Node, no build step, nothing to compile.

macOS and Linux

curl -fsSL https://agent.pathvela.com/install.sh | sh

Windows

irm https://agent.pathvela.com/install.ps1 | iex

One-off with npx

If you have Node 18+ and just want to run it once without installing:

npx pathvela

npx pathvela and npx -y @poolot/lily are equivalent — the pathvela package is a thin alias.

Verify the install:

lily --help

Full details are in the CLI installation guide.

Keeping it updated

The CLI updates itself automatically — it checks for a newer release in the background and upgrades in place, so you normally never think about it. To skip the check for a single run, add --no-update:

lily --no-update run "..."

To force the latest version now, just re-run the installer above; it always fetches the current release.

Optional: run it in the background (auto mode)

By default the CLI runs only while you're using it. If you want your Pathvela browser tab or app to reach the agent on your machine, install it as a background service:

lily bridge install

This registers a login-start service (launchd, systemd, or a Windows startup entry) so the agent is available whenever you're signed in. It's entirely opt-in — see Auto mode for what it enables and how to remove it (lily bridge uninstall).

Install the SDK

Add the SDK to any JavaScript or TypeScript project:

npm install @poolot/lily-web

The package is ESM and ships TypeScript types. The same import works in the browser and on Node:

import { createLilyAgent } from '@poolot/lily-web'

In the browser, the agent runs from a small WebAssembly engine bundled with the package. On Node, it runs on a local harness when one is available, and otherwise falls back to the same WebAssembly engine. See Browser vs Node for the details, and the SDK installation guide for asset serving and content-security-policy notes.

Requirements

  • CLI (native install): macOS, Linux, or Windows on x64 or arm64. No Node required.
  • CLI (npx): Node 18 or newer.
  • SDK: Node 18+ for the toolchain. In the browser, serve your app over HTTPS or localhost (WebAssembly needs a secure context).

Next