Skip to content

ui

Start a local web server providing an interactive development UI.

The UI provides:

  • Model explorer with SQL preview
  • Data preview from target database
  • DAG visualization
  • Column-level lineage
  • Run history

Usage

bash
leapsql ui [flags]

Options

OptionShortDefaultDescription
--no-browserfalseDon't auto-open browser
--port0Port to serve on (default: 8765)
--watchtrueWatch for file changes

Global Options

OptionShortDefaultDescription
--configconfig file (default: ./leapsql.yaml)
--databasePath to DuckDB database (empty for in-memory)
--envEnvironment name
--macros-dirPath to macros directory
--models-dirPath to models directory
--output-oOutput format (auto|text|markdown|json)
--project-dir-CProject root directory (auto-detected from models-dir or config file location)
--seeds-dirPath to seeds directory
--statePath to state database
--target-tTarget environment to use (e.g., dev, staging, prod)
--verbose-vfalseVerbose output

Examples

bash
# Start UI on default port
leapsql ui

# Start on custom port
leapsql ui --port 3000

# Start without auto-opening browser
leapsql ui --no-browser

Released under the MIT License.