Getting started

Command line usage

These examples assume that you have installed Lume as the lume executable:

# Build the site in the current directory
lume

# Build the site and boot up a web server
# that refreshes automatically for every change
lume --serve # or -s

# Change the web server port to localhost:8000
lume --serve --port=8000

# Build the site overriding some config values
lume --src=from --dest=build --location=https://my-site.com/blog/

# Show the version
lume --version # or -V

# Show help information
lume --help # or -h

# Create a _config.js file
lume init

# Build the site located in a different directory
lume --root ./my-site

# Build in development mode to view draft pages
lume --dev

# Build and watch changes but without starting a webserver
lume --watch # or -w

# Pass additional flags to your site code
lume -- flag1 flag2

# Run a custom script
lume run gzip