Getting Started

Using the Installer Script

Linux

Open a terminal and run the following command to install the CLI.

curl -fsSL https://codeberg.org/drmathias/jvln/raw/branch/main/scripts/install-cli.sh | sh

This installs the jvln binary to $XDG_BIN_HOME (or $HOME/.local/bin if unset). The script will tell you if this directory isn’t on your PATH and, if so, which line to add to your shell profile (e.g. ~/.bashrc):

export PATH="$HOME/.local/bin:$PATH"

After editing your profile, restart your terminal or run source ~/.bashrc (or the equivalent for your shell) to apply the change.

Confirm that the installation is successful by running jvln --version.

Options

The installer supports the following environment variables:

Variable	Description	Default
RELEASE	Release tag to install	latest
INSTALL_DIR	Directory to install the binary into	$XDG_BIN_HOME or $HOME/.local/bin

MacOS

Open a terminal and run the following command to install the CLI.

curl -fsSL https://codeberg.org/drmathias/jvln/raw/branch/main/scripts/install-cli.sh | sh

This installs the jvln binary to $XDG_BIN_HOME (or $HOME/.local/bin if unset). The script will tell you if this directory isn’t on your PATH and, if so, which line to add to your shell profile (e.g. ~/.zshrc):

export PATH="$HOME/.local/bin:$PATH"

After editing your profile, restart your terminal or run source ~/.zshrc (or the equivalent for your shell) to apply the change.

Confirm that the installation is successful by running jvln --version.

Options

The installer supports the following environment variables:

Variable	Description	Default
RELEASE	Release tag to install	latest
INSTALL_DIR	Directory to install the binary into	$XDG_BIN_HOME or $HOME/.local/bin

Build From Source

Linux

Required Dependency

When building from source, you must separately install libmsquic. For installation instructions and further information, please refer to the Microsoft documentation.

Prerequisites

The following dependencies must be installed on your machine.

• .NET SDK (see global.json for the specific version)
• libmsquic
• git

Instructions

First, navigate to your preferred directory and clone the source code using git.

git clone https://codeberg.org/drmathias/jvln.git

To build, navigate to the correct project and publish the binary.

cd jvln/src/Jvln.Cli
dotnet publish -r $([ "$(uname -m)" = "arm64" ] && echo "linux-arm64" || echo "linux-x64") -o ./dist

Next, copy the published files to a location of your choice, then symlink the binary to a location that is on your PATH.

mkdir -p ~/.local/lib
mv ./dist ~/.local/lib/jvln
ln -s ~/.local/lib/jvln/jvln ~/.local/bin/jvln

Confirm that the installation is successful by running jvln --version.

MacOS

Required Dependency

When building from source, you must separately install libmsquic. For installation instructions and further information, please refer to the Microsoft documentation.

Prerequisites

The following dependencies must be installed on your machine.

• .NET SDK (see global.json for the specific version)
• libmsquic
• git

Instructions

First, navigate to your preferred directory and clone the source code using git.

git clone https://codeberg.org/drmathias/jvln.git

To build, navigate to the correct project and publish the binary.

cd jvln/src/Jvln.Cli
export DYLD_FALLBACK_LIBRARY_PATH=$DYLD_FALLBACK_LIBRARY_PATH:$(brew --prefix)/lib
dotnet publish -r $([ "$(uname -m)" = "arm64" ] && echo "osx-arm64" || echo "osx-x64") -o ./dist

Next, copy the published files to a location of your choice, then symlink the binary to a location that is on your PATH.

mkdir -p ~/.local/lib
mv ./dist ~/.local/lib/jvln
ln -s ~/.local/lib/jvln/jvln ~/.local/bin/jvln

Confirm that the installation is successful by running jvln --version.

Windows

Windows Compatibility

Jvln depends on libmsquic, which is only available for Windows 11, Windows Server 2022 and later.

Prerequisites

The following dependencies must be installed on your machine.

• .NET SDK (see global.json for the specific version)
• git

Instructions

First, navigate to your preferred directory and clone the source code using git.

git clone https://codeberg.org/drmathias/jvln.git

To build, navigate to the correct project and publish the binary.

Set-Location jvln/src/Jvln.Cli
$rid = if ([System.Runtime.InteropServices.RuntimeInformation]::OSArchitecture -eq 'Arm64') {
    "win-arm64"
} else {
    "win-x64"
}
dotnet publish -r $rid -o ./dist

Next, copy the published files to a location of your choice, then add the folder to your PATH.

Move-Item .\dist "$env:LOCALAPPDATA\jvln"
$currentPath = [Environment]::GetEnvironmentVariable("PATH", [EnvironmentVariableTarget]::User)
[Environment]::SetEnvironmentVariable("PATH", "$currentPath;$env:LOCALAPPDATA\jvln", [EnvironmentVariableTarget]::User)

Restart your terminal after updating PATH for your changes to take effect.

Confirm that the installation is successful by running jvln --version.