Skip to main content

Installation

Wvlet is available as a command-line tool. You can install wvlet using Homebrew on macOS or download a binary package for other platforms.

Command Line Tools​

info

Language SDKs are also available for Python and TypeScript to compile Wvlet queries programmatically.

Mac OS X​

For macOS, you can install wvlet using Homebrew:

brew install wvlet/wvlet/wvlet

This will install wv (wvlet) command to your system.

To upgrade wvlet, run:

brew upgrade wvlet

If the latest version is not installed, try brew update to update the formula, then run brew upgrade wvlet again.

info

The formula for homebrew can be found at https://github.com/wvlet/homebrew-wvlet

Linux, Windows, and Other Platforms​

For other platforms (e.g., Linux, Windows, etc.), download a binary package wvlet-cli-(version).tar.gz from the release page https://github.com/wvlet/wvlet/releases

You can find wv command in the bin directory of the package. Add the bin directory to your PATH environment variable.

JDK17 or later is required to run wvlet. Set JAVA_HOME environment variable to the JDK path.

Quick Start​

After installing wvlet, start learning the query syntax of Wvlet:

Language SDKs​

If you want to integrate Wvlet compilation into your applications, install one of our language SDKs:

Python​

pip install wvlet

TypeScript/JavaScript​

npm install @wvlet/wvlet

See Language Bindings for more details and usage examples.

Building From Source​

See Building Wvlet for building wvlet from source.