Building Wvlet
Building from Source
To build Wvlet, you will need at least JDK17 or later. To test Trino connector, JDK22 or later is required (as of September 2024).
# Clone the source code repository
git clone git@github.com:wvlet/wvlet.git
cd wvlet
./sbt
## This will install wv command to your ~/local/bin
sbt:wvlet> cli/packInstall
You can find the wvlet command in ~/local/bin/wv
. For convenience, you can set PATH
environment variable like this:
export PATH=$HOME/local/bin:$PATH
Mac users can install wvlet with Homebrew: brew install wvlet/wvlet/wvlet
Building Documentation
Wvlet Documentation https://wvlet.org/wvlet is built with Docusaurus and GitHub Pages. To edit the documentation, you can start a local server to preview the documentation changes:
cd website
Then start a documentation server at localhost:3000:
npm start
The server will be reloaded automatically when you update .md files.
website/docs/
directory contains the markdown files for the documentation. Once your change is merged to the main branch, GitHub Action will update the public website automatically.