Reset Framework CLI

1.2.5 verified Sat Apr 25 auth: no javascript

The official command-line tool for building, developing, and packaging applications with Reset Framework. Current stable version is 1.2.5, with a release cadence aligned with the core framework (published after schema, backend, and SDK packages). Key differentiators: it orchestrates the full lifecycle (create, dev, build, package, doctor), optionally compiles the runtime from source via CMake/Ninja, and remains thin by delegating platform logic to separate runtime packages. Requires Node.js >=20.19.0.

Common errors

error Error: Cannot find module '@reset-framework/schema' ↓

cause The CLI requires the schema package to be installed as a dependency or globally.

fix

Install the missing package: npm install @reset-framework/schema or ensure it's in the project's node_modules.

error Error: reset-framework-cli: command not found ↓

cause The CLI is not installed or not in PATH.

fix

Install globally: npm install -g reset-framework-cli. Alternatively, use npx reset-framework-cli.

error node: --experimental-loader is experimental. (Use `node --experimental-loader ...`) ↓

cause The CLI uses experimental loaders; this warning is non-fatal but may cause issues on older Node versions.

fix

Update Node.js to >=20.19.0. Suppress with NODE_NO_WARNINGS=1 if desired.

Warnings

breaking Node.js version must be >=20.19.0. Running with an older version will fail with engine validation error. ↓

fix Update Node.js to version 20.19.0 or later.

gotcha Source build requires CMake, Ninja, Git, and a native compiler toolchain. Missing any will cause cryptic build errors. ↓

fix Install CMake (>=3.15), Ninja, Git, and a C++ compiler (e.g., GCC, Clang, MSVC).

deprecated The CLI is not a library and should not be imported or required directly. Attempting to require('reset-framework-cli') returns an object, but no stable API is provided. ↓

fix Use the CLI via npx or global install, or invoke the binary from child process.

gotcha First source build bootstraps vcpkg into ~/.reset-framework-cli/vcpkg, which downloads and compiles dependencies. This can take significant time and disk space. ↓

fix Ensure at least 5GB free space and a stable internet connection. Consider using an existing vcpkg toolchain if available.

gotcha Runtime packages are platform-specific. The CLI will fail if no bundled runtime package exists for the current OS/architecture. ↓

fix Ensure @reset-framework/runtime-* package for your platform is installed. Use --runtime-source to compile from source if no bundled runtime is available.

breaking The CLI must be published after @reset-framework/schema, @reset-framework/backend, and @reset-framework/sdk. Installing a mismatched version can cause runtime errors. ↓

fix Align versions with the core framework release. Check peer dependencies or publish order documentation.

Install

npm install reset-framework-cli

yarn add reset-framework-cli

pnpm add reset-framework-cli

Imports

reset-framework-cli
```
npx reset-framework-cli create-app my-app
```
This is a CLI tool, not a library. Use npx or global install.

bin

wrong

Assuming the CLI is importable as a module

correct

package.json: { "bin": { "reset-framework-cli": "./bin/cli.js" } }

The package exposes a binary, not a JavaScript module. Use child_process.exec or similar.

create-app
wrong
```
reset-framework-cli new my-app
```
correct
```
reset-framework-cli create-app my-app
```
The command is `create-app`, not `new` or `init`.

Quickstart

Demonstrates installing the CLI globally, creating a new app, running dev server, building, packaging, and running diagnostics.

# Install globally
npm install -g reset-framework-cli

# Create a new project
reset-framework-cli create-app my-app

# Change directory and start development
cd my-app
reset-framework-cli dev

# Build for production
reset-framework-cli build

# Package the desktop app
reset-framework-cli package

# Verify setup
reset-framework-cli doctor