Commands

Install dependencies

Command	Purpose
npm install	Install project dependencies in node_modules/.

The repository does not include a package lock. @elune/embedded uses the bare GitHub dependency spmurrayzzz/elune. No npm registry publication or sibling checkout is required. See Elune integration.

Run the app and documentation

Command	Purpose
npm run dev	Start Vite, the pi API middleware, and the VitePress middleware.
npm run build	Build the Vue app and the VitePress site.
npm run preview	Preview the built Vue app.
npm run docs:dev	Start the VitePress development server.
npm run docs:build	Build only the VitePress site.
npm run docs:preview	Preview the built VitePress site.

npm run build writes the Vue app to dist/ and the documentation to dist/docs/. npm run preview does not mount the pi API or terminal backend.

Run and package Electron

Command	Purpose
npm run electron:dev	Open Electron at http://localhost:5173. Start Vite first.
npm run electron:build	Build the app and documentation, then package Electron in release/.
npm run local-publish	macOS only: build the Apple silicon app, copy it to /Applications/, and link the CLI.

For Linux installation and launchers, follow Linux installation. The repository's publish script and bin/leyline do not install or launch Linux packages.

Capture screenshots and video

Command	Purpose
npm run screenshot	Save a live browser capture to screenshots/current.png by default.
npm run docs:screenshots	Refresh sanitized VitePress and README product images.
npm run video	Save a browser walkthrough to screenshots/walkthrough.webm by default.
npm run video:mp4	Use ffmpeg to convert the walkthrough to MP4.

The screenshot and video commands require a running app. The documentation capture uses intercepted fixture data. See Environment variables for URL, path, and video size overrides.

Refresh only the tracing images with:

DOCS_SCREENSHOT_FILTER=trace-inspector.png,trace-workspace.png,trace-explorer.png,trace-capture.png,trace-mobile.png,tracing.png npm run docs:screenshots

This command uses sanitized fixtures, including capture status and trace pagination. It does not request real traces or run a model. See Screenshots and video for output paths and dimensions.

Use the packaged CLI

On Apple silicon macOS, run npm run local-publish first. On Linux, install the Linux launcher. Ensure ~/.local/bin is on your PATH.

leyline

This command opens or focuses Electron. It creates a pi session for the current shell directory in the active window.

leyline -n

The -n option opens a new Electron window at the home workspace. It does not create a pi session. It is the only supported CLI option, and the CLI does not accept a directory argument.

Set LEYLINE_CWD to change the directory for plain leyline. It does not affect leyline -n. Set LEYLINE_APP to select a different macOS app bundle or, with the documented Linux launcher, an executable path. See Environment variables.