CLI

This reference guide describes the create-thulite CLI and all of its options.

Usage#

npm create thulite@latest [DIRECTORY] [TEMPLATE] -- [OPTIONS]

The CLI creates a new Thulite project in the specified directory, using the specified template. When running in a TTY (interactive terminal), it starts in interactive mode and prompts for any missing information.

Arguments#

DIRECTORY#

The name of the directory to create the project in. A string — for example "my-project". Defaults to "thulite-project" when not provided in non-interactive mode, or prompted for in interactive mode.

TEMPLATE#

The template to scaffold the project from. A string — must be one of the available template names. Can be passed as the second positional argument as a shorthand for --template.

Options#

--template#

Alias: -t

The template to scaffold the project from. A string — must be one of the available template names listed below. When omitted in interactive mode, the CLI will prompt for a framework and variant selection. When omitted in non-interactive mode, defaults to "basic".

Templates with recommended integrations (SEO and Images):

Templates without recommended integrations:

Examples:

npm create thulite@latest my-project -- --template doks
npm create thulite@latest my-project -- -t tailwindcss-rec
npm create thulite@latest my-project doks

--immediate#

Alias: -i

A boolean flag. When set, the CLI will automatically install dependencies and start the development server after scaffolding. When omitted in interactive mode, the CLI will prompt whether to install and start now. When omitted in non-interactive mode, defaults to false.

Example:

npm create thulite@latest my-project -- --template basic-rec --immediate

--overwrite#

A boolean flag. When set, any existing files in the target directory will be removed before scaffolding. When omitted in interactive mode, the CLI will prompt how to proceed if the target directory is not empty. When omitted in non-interactive mode, the operation is cancelled if the target directory is not empty.

Example:

npm create thulite@latest my-project -- --overwrite

--interactive / --no-interactive#

A boolean flag. Forces the CLI to run in interactive or non-interactive mode, overriding the automatic TTY detection. Use --no-interactive to run without prompts, for example in CI/CD environments. Defaults to the result of TTY detection.

Example:

npm create thulite@latest my-project -- --template doks --no-interactive

--help#

Alias: -h

A boolean flag. Prints the help message describing usage, available options, and templates, then exits.

Example:

npm create thulite@latest -- --help