CLI / Engine

Engine versions

Inspect, install, select, update, and remove the engine dependency used by a project.

Projects use an exact stable engine dependency. The CLI does not install a machine-global engine; it changes the project dependency and its lockfile.

shell

bornengine engine current
bornengine engine list
bornengine engine install 0.8.0
bornengine engine use 0.8.0
bornengine engine use ../BornEngine

engine current reports the active source. engine list lists stable releases available from npm. engine install [version] installs/selects a stable release for the project; engine update refreshes the engine dependency; and engine remove [version] removes a project engine dependency. Check the active selection before removing a version.

Local checkout versus release

Use a path with engine use while editing the engine. Switch back to a published release by passing its version. BORNENGINE_PATH can provide a default local checkout, but an explicit --engine-path wins.

CLI upgrade

The top-level upgrade command manages the CLI itself:

shell

bornengine upgrade
bornengine upgrade --latest

The separate update command only checks for a CLI release and prints an installation instruction. It never silently updates the binary.

Command reference

Show the selected engine

Print the engine version or path currently selected by the project.

bornengine engine current

Options

-v, --verbose (repeatable)

Behavior

Reads the active engine selection without changing it.

Examples

bornengine engine current

Install an engine version

Install a BornEngine engine release for later selection.

bornengine engine install [version]

Options

[version] selects a release; omit it for the CLI's default
-v, --verbose (repeatable)

Behavior

Adds an engine version to the local engine store. Installation does not implicitly rewrite the project's selected version.

Examples

bornengine engine install 0.8.0

bornengine engine install

List installed engines

Show engine versions available in the local engine store.

bornengine engine list

Options

-v, --verbose (repeatable)

Behavior

Lists installed versions and identifies the active selection when one exists.

Examples

bornengine engine list

Update installed engine releases

Refresh or update engine versions in the local store.

bornengine engine update

Options

-v, --verbose (repeatable)

Behavior

Updates engine installation metadata without changing the CLI binary itself.

Examples

bornengine engine update

Remove an engine version

Delete an installed engine version from the local store.

bornengine engine remove [version]

Options

[version] identifies the installed release
-v, --verbose (repeatable)

Behavior

Removes a stored version. Check engine current and project configuration before deleting an active version.

Examples

bornengine engine remove 0.4.15

Select an engine source

Choose an installed version or a local engine path for the project.

bornengine engine use <version-or-path>

Options

<version-or-path> can identify an installed release or local path
-v, --verbose (repeatable)

Behavior

Changes the engine source used by subsequent project commands.

Examples

bornengine engine use 0.8.0

bornengine engine use ../BornEngine

Upgrade the CLI

Install a newer BornEngine CLI release.

bornengine upgrade [version] [--latest]

Options

[version] selects a release
--latest selects the latest release
-v, --verbose (repeatable)

Behavior

Runs the CLI upgrade flow for a selected release. Use update when you only want to check for a newer CLI release.

Examples

bornengine upgrade

bornengine upgrade 0.2.0

bornengine upgrade --latest

Edit this page ↗