Edit on GitHub

Usage

Differs from Ruby Jekyll — replaced

No new, doctor, or import commands, but extra ones Jekyll lacks: plugins, render, routes, variables, and benchmark. serve renders in memory (nothing is written to disk) and live reload is always on.

All differences →

Jigyll's CLI mirrors Jekyll's most-used commands:

jigyll build       # build the site in the current directory into _site
jigyll serve       # serve at http://localhost:4000; reload on changes
jigyll clean       # remove the generated _site directory
jigyll help        # list commands
jigyll help build  # help for a specific command

Common flags

These work on both build and serve:

Flag Purpose
--source, -s Source directory (default: current)
--destination, -d Output directory (default: ./_site)
--config Comma-separated config files; later files override earlier ones
--drafts, -D Render posts in _drafts
--future Render posts with future dates
--unpublished Render pages/posts marked published: false
--incremental, -I Rebuild only changed files
--watch, -w Rebuild on file changes (default: off for build, on for serve)
--force_polling Use a polling file watcher
--quiet, -q / --verbose, -V Less / more output

Flags take precedence over _config.yml. Set JEKYLL_ENV=production to build in production mode.

build

Renders the site to the destination directory. --dry-run (-n) builds without writing.

serve

Builds the site and serves it locally, rebuilding on change.

Flag Purpose
--host, -H Host to bind (default 127.0.0.1)
--port, -P Port (default 4000)
--open-url, -o Open the site in a browser

Differs from Jekyll. serve renders pages on the fly and does not write to the filesystem; live reload is always on; and watching also reloads _config.yml and data files. --baseurl, --detach, and --ssl-* are not implemented.

Jigyll-only commands

Jigyll-only. These have no Jekyll counterpart:

Command Purpose
jigyll plugins List the plugin names the binary recognizes
jigyll render PATH Render one file or URL path to stdout
jigyll routes Print the site's permalinks and their source files
jigyll variables [PATH] Print the site's (or one document's) Liquid variables
jigyll benchmark Rebuild repeatedly for ten seconds, with CPU profiling
jigyll version Print the version

Not implemented

Jekyll's new, new-theme, doctor, and import commands don't exist, nor do the --lsi and --limit-posts flags.