Skip to content

CLI Reference ​

Usage ​

sh
$ npx velite <command> [options]
sh
$ pnpm velite <command> [options]
sh
$ yarn velite <command> [options]
sh
$ bun velite <command> [options]

Options ​

OptionDescription
-v, --versionPrint version number
-h, --helpPrint help information

velite build ​

Build the contents with default config file in current directory.

Usage ​

sh
$ velite build [options]

Options ​

OptionDescriptionDefault
-c, --config <path>Use specified config filevelite.config.js
--cleanClean output directory before buildfalse
--watchWatch for changes and rebuildfalse
--verbosePrint additional informationfalse
--silentSilent mode (no output)false
--strictTerminate process on schema validation errorfalse
--debugOutput full error stack tracefalse

velite dev ​

Build the contents with watch mode.

Usage ​

sh
$ velite dev [options]

Options ​

OptionDescriptionDefault
-c, --config <path>Use specified config filevelite.config.js
--cleanClean output directory before buildfalse
--verbosePrint additional informationfalse
--silentSilent mode (no output)false
--strictTerminate process on schema validation errorfalse
--debugOutput full error stack tracefalse

velite init ​

TODO: Create a default config file in current directory.

Usage ​

sh
$ velite init [options]

Distributed under the MIT License.