CLI / Project

Project commands

Scaffold a new BornEngine project interactively, non-interactively, or in an existing directory.

Interactive projects

shell

bornengine create

create prompts for the project name, package manager, and stable engine version. It is intentionally interactive and does not take a project-name argument.

Scriptable projects

shell

bornengine new MyGame --package-manager npm --engine-version 0.8.0

Use --pm as the shorter package-manager flag, -e for --engine-version, and --engine for --engine-path. A local engine checkout is useful while developing BornEngine itself:

shell

bornengine new EngineTest --engine-path ../BornEngine

The generated package uses the selected manager’s dependency syntax: pnpm uses link:, while npm and Yarn use file: for a local checkout.

Initialize a directory

shell

bornengine init --package-manager pnpm

init adds a scaffold to an otherwise empty directory and only creates files that do not already exist. new refuses a populated target directory. Neither command overwrites existing files, and there is no --force flag.

The command reference below includes each option and the related setup path.

Command reference

Create a project

Interactively scaffold a new BornEngine project.

bornengine create

Options

-v, --verbose (repeatable)

Behavior

Prompts for the project name, package manager, and stable engine version. It refuses to overwrite populated or conflicting files.

Examples

bornengine create

Create a project non-interactively

Scaffold a project from a script or CI job.

bornengine new <project-name> [--package-manager <pnpm|npm|yarn>] [--engine-version <version>] [--engine-path <path>]

Options

--package-manager <pnpm|npm|yarn>, --pm <pnpm|npm|yarn>
--engine-version <version>, -e <version>
--engine-path <path>, --engine <path>
-v, --verbose (repeatable)

Behavior

Uses explicit arguments instead of prompts and refuses to overwrite populated or conflicting files.

Examples

bornengine new MyGame --package-manager npm --engine-version 0.8.0

Initialize the current directory

Scaffold BornEngine files in the current project directory.

bornengine init [--package-manager <pnpm|npm|yarn>] [--engine-version <version>] [--engine-path <path>]

Options

--package-manager <pnpm|npm|yarn>, --pm <pnpm|npm|yarn>
--engine-version <version>, -e <version>
--engine-path <path>, --engine <path>
-v, --verbose (repeatable)

Behavior

Initializes a project without taking a project-name argument. Existing conflicting files are protected.

Examples

bornengine init --package-manager pnpm

Edit this page ↗