Single Binary

The single binary is the simplest way to run Liwan. It is self-contained and does not require a separate database service.

Liwan provides pre-built binaries for Linux (x86_64/ARM64) and macOS (ARM64). Linux builds are statically linked with musl libc, so they should work on most Linux distributions.

Installation

1. Download and extract Liwan

   These examples install Liwan into ~/.local/bin. Replace that path if you prefer a different install directory.

   Linux x86_64

   # Download the latest release for Linux x86_64
   curl -JLO 'https://github.com/explodingcamera/liwan/releases/latest/download/liwan-x86_64-unknown-linux-musl.tar.gz'
   
   # Create the install directory if it does not exist
   mkdir -p ~/.local/bin
   
   # Extract the liwan binary into the install directory
   tar -xzf liwan-x86_64-unknown-linux-musl.tar.gz -C ~/.local/bin liwan
   
   # Make the binary executable
   chmod +x ~/.local/bin/liwan
   
   # Confirm the binary works
   ~/.local/bin/liwan --help

   Linux ARM64

   # Download the latest release for Linux ARM64
   curl -JLO 'https://github.com/explodingcamera/liwan/releases/latest/download/liwan-aarch64-unknown-linux-musl.tar.gz'
   
   # Create the install directory if it does not exist
   mkdir -p ~/.local/bin
   
   # Extract the liwan binary into the install directory
   tar -xzf liwan-aarch64-unknown-linux-musl.tar.gz -C ~/.local/bin liwan
   
   # Make the binary executable
   chmod +x ~/.local/bin/liwan
   
   # Confirm the binary works
   ~/.local/bin/liwan --help

   macOS ARM64

   # Download the latest release for macOS ARM64
   curl -JLO 'https://github.com/explodingcamera/liwan/releases/latest/download/liwan-aarch64-apple-darwin.tar.gz'
   
   # Create the install directory if it does not exist
   mkdir -p ~/.local/bin
   
   # Extract the liwan binary into the install directory
   tar -xzf liwan-aarch64-apple-darwin.tar.gz -C ~/.local/bin liwan
   
   # Make the binary executable
   chmod +x ~/.local/bin/liwan
   
   # Confirm the binary works
   ~/.local/bin/liwan --help

2. Add Liwan to your PATH

   If ~/.local/bin is not already in your PATH, add it to your shell profile:

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

3. Start Liwan

   liwan

   The first run prints a setup URL. Open it to create your first user, project, and entity.

   It looks like you're running Liwan for the first time!
   You can get started by visiting: http://localhost:9042/setup?t=1234567890
   To see all available commands, run `liwan --help`

For production, see Running Liwan as a Service to start Liwan automatically on boot.