Squarkdown CLI

Last updated 2026 October 10

Squarkdown is a command-line application with a small, focused set of commands.


Help

squarkdown --help
squarkdown -h

This shows all of the Squarkdown commands available.


Version

squarkdown --version

This shows which version of Squarkdown you have installed.


Squarkup

squarkdown
squarkdown --assets
squarkdown --fonts
squarkdown --no-parallel

This runs the entire squarkup pipeline, (optionally) with assets and fonts preprocessing.

You must have a squarkup config file to run this command, otherwise Squarkdown cannot find your project root.

TIP

Since assets are unlikely to change very often, you may want to leave out --assets for local development builds. I usually configure 2 separate npm scripts:

"scripts": {
   "prep": "squarkdown",
   "prepx": "squarkdown --assets --fonts"
}

Then local development uses prep while production builds use prepx.


Init (in development)

squarkdown init

This initialises your squarkup.toml for you, like npm init or sv create.

You may find this helpful if you’re new to Squarkdown and are overwhelmed by all the configuration options!