reset-framework-cli 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jan Kordoš
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# reset-framework-cli
+
+`reset-framework-cli` is the developer-facing command-line interface for Reset Framework.
+
+## Install
+
+```bash
+npm install -g reset-framework-cli
+```
+
+## Commands
+
+- `reset-framework-cli create-app my-app`
+- `reset-framework-cli dev`
+- `reset-framework-cli build`
+- `reset-framework-cli package`
+- `reset-framework-cli doctor`
+
+## Package boundary
+
+- `reset-framework-cli` orchestrates the framework.
+- `@reset-framework/native` provides the CMake-based runtime source package.
+- `@reset-framework/sdk` provides the frontend bridge package.
+- `@reset-framework/schema` provides the config schema package.
+
+## How it works
+
+- `reset-framework-cli dev` and `reset-framework-cli build` compile the native runtime into an app-local cache under `.reset/framework`.
+- The generated desktop app is assembled under `.reset/build`.
+- On first native build, the CLI will reuse an existing vcpkg toolchain when available, or bootstrap one into `~/.reset-framework-cli/vcpkg`.
+- The CLI remains thin. Native platform logic lives in the native package, not in command code.
+
+## Requirements
+
+- Node.js `>= 20.19.0`
+- CMake
+- Ninja
+- Git
+- A native compiler toolchain for the target platform
+
+## Publish model
+
+`reset-framework-cli` should be published only after:
+
+1. `@reset-framework/schema`
+2. `@reset-framework/sdk`
+3. `@reset-framework/native`

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "reset-framework-cli",
+  "version": "0.2.0",
+  "type": "module",
+  "description": "Command-line tooling for Reset Framework.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "dependencies": {
+    "@reset-framework/native": "0.2.0",
+    "@reset-framework/schema": "0.2.0",
+    "@reset-framework/sdk": "0.2.0"
+  },
+  "bin": {
+    "reset-framework-cli": "./src/index.js"
+  },
+  "files": [
+    "src",
+    "templates",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "node ./src/index.js",
+    "doctor": "node ./src/index.js doctor"
+  }
+}

package/src/commands/build.js

@@ -0,0 +1,115 @@
+import { buildFrameworkRuntime } from "../lib/framework.js"
+import { stageMacOSAppBundle } from "../lib/output.js"
+import { resolveNpmCommand, runCommand } from "../lib/process.js"
+import {
+  assertAppProject,
+  assertFrameworkInstall,
+  loadResetConfig,
+  resolveAppOutputPaths,
+  resolveAppPaths,
+  resolveConfigPath,
+  resolveFrontendDir,
+  resolveFrameworkBuildPaths,
+  resolveFrameworkPaths
+} from "../lib/project.js"
+import {
+  createProgress,
+  printBanner,
+  printKeyValueTable,
+  printSection,
+  printStatusTable
+} from "../lib/ui.js"
+
+export const description = "Build the frontend, runtime, and final desktop app bundle"
+
+export async function run(context) {
+  const dryRun = Boolean(context.flags["dry-run"])
+  const skipFrontend = Boolean(context.flags["skip-frontend"])
+  const skipRuntime = Boolean(context.flags["skip-runtime"])
+  const skipStage = Boolean(context.flags["skip-stage"])
+
+  const appPaths = resolveAppPaths(context.projectRoot)
+  const frameworkPaths = resolveFrameworkPaths()
+  assertAppProject(appPaths)
+  assertFrameworkInstall(frameworkPaths)
+  const config = loadResetConfig(appPaths)
+  assertAppProject(appPaths, config)
+  const outputPaths = resolveAppOutputPaths(appPaths, config)
+  const configPath = resolveConfigPath(appPaths)
+  const frontendDir = resolveFrontendDir(appPaths, config)
+  const frameworkBuildPaths = resolveFrameworkBuildPaths(appPaths)
+  const steps = [
+    !skipFrontend ? "Build frontend" : null,
+    !skipRuntime ? "Build runtime" : null,
+    !skipStage ? "Stage desktop bundle" : null
+  ].filter(Boolean)
+
+  printBanner("reset-framework-cli build", description)
+  printSection("Project")
+  printKeyValueTable([
+    ["Config", configPath],
+    ["Frontend", frontendDir],
+    ["Output", outputPaths.appBundlePath]
+  ])
+  console.log("")
+
+  printSection("Plan")
+  printStatusTable([
+    [skipFrontend ? "skip" : "ready", "Frontend", skipFrontend ? "Skipping frontend build" : "Build static frontend assets"],
+    [skipRuntime ? "skip" : "ready", "Runtime", skipRuntime ? "Skipping release runtime build" : "Configure and build the native runtime"],
+    [skipStage ? "skip" : "ready", "Bundle", skipStage ? "Skipping app bundle staging" : "Assemble the final desktop app bundle"]
+  ])
+
+  if (dryRun) {
+    console.log("")
+    printSection("Dry run")
+    printStatusTable(
+      steps.length > 0
+        ? steps.map((step) => ["plan", step, "No changes will be written"])
+        : [["warn", "Nothing to do", "All build phases were skipped"]]
+    )
+    return
+  }
+
+  if (steps.length === 0) {
+    console.log("")
+    printSection("Result")
+    printStatusTable([["warn", "Nothing to do", "All build phases were skipped"]])
+    return
+  }
+
+  console.log("")
+  const progress = createProgress(steps.length, "Build")
+
+  if (!skipFrontend) {
+    await runCommand(resolveNpmCommand(), ["run", "build"], {
+      cwd: frontendDir,
+      dryRun
+    })
+    progress.tick("Frontend assets built")
+  }
+
+  if (!skipRuntime) {
+    await buildFrameworkRuntime(frameworkPaths, frameworkBuildPaths, "release", {
+      cwd: appPaths.appRoot,
+      dryRun
+    })
+    progress.tick("Native runtime built")
+  }
+
+  if (!skipStage) {
+    await stageMacOSAppBundle(frameworkBuildPaths, appPaths, config, {
+      dryRun,
+      outputPaths,
+      configPath
+    })
+    progress.tick("Desktop app bundle staged")
+  }
+
+  console.log("")
+  printSection("Result")
+  printStatusTable([
+    ["done", "Build output", outputPaths.outputRoot],
+    ["done", "Desktop app", outputPaths.appBundlePath]
+  ])
+}

package/src/commands/dev.js

@@ -0,0 +1,160 @@
+import { buildFrameworkRuntime } from "../lib/framework.js"
+import {
+  registerChildCleanup,
+  resolveNpmCommand,
+  spawnCommand,
+  waitForProcessExit,
+  waitForUrl
+} from "../lib/process.js"
+import {
+  assertAppProject,
+  assertFrameworkInstall,
+  loadResetConfig,
+  resolveAppPaths,
+  resolveConfigPath,
+  resolveDevServerOptions,
+  resolveFrontendDir,
+  resolveFrameworkBuildPaths,
+  resolveFrameworkPaths
+} from "../lib/project.js"
+import {
+  createProgress,
+  printBanner,
+  printKeyValueTable,
+  printSection,
+  printStatusTable
+} from "../lib/ui.js"
+
+export const description = "Run the frontend dev server and native host"
+
+export async function run(context) {
+  const dryRun = Boolean(context.flags["dry-run"])
+  const skipFrontend = Boolean(context.flags["skip-frontend"])
+  const skipRuntime = Boolean(context.flags["skip-runtime"])
+  const noOpen = Boolean(context.flags["no-open"])
+
+  const appPaths = resolveAppPaths(context.projectRoot)
+  const frameworkPaths = resolveFrameworkPaths()
+  assertAppProject(appPaths)
+  assertFrameworkInstall(frameworkPaths)
+  const config = loadResetConfig(appPaths)
+  assertAppProject(appPaths, config)
+  const devServer = resolveDevServerOptions(config)
+  const configPath = resolveConfigPath(appPaths)
+  const frontendDir = resolveFrontendDir(appPaths, config)
+  const frameworkBuildPaths = resolveFrameworkBuildPaths(appPaths)
+  const steps = [
+    !skipRuntime ? "Build native runtime" : null,
+    !skipFrontend ? "Start frontend dev server" : null,
+    !noOpen ? "Launch desktop window" : null
+  ].filter(Boolean)
+
+  printBanner("reset-framework-cli dev", description)
+  printSection("Project")
+  printKeyValueTable([
+    ["Config", configPath],
+    ["Frontend", frontendDir],
+    ["Dev URL", config.frontend.devUrl]
+  ])
+  console.log("")
+
+  printSection("Plan")
+  printStatusTable([
+    [skipRuntime ? "skip" : "ready", "Runtime", skipRuntime ? "Reusing existing native dev build" : "Configure and build the native runtime"],
+    [skipFrontend ? "skip" : "ready", "Frontend", skipFrontend ? "Expecting an already running dev server" : "Start the frontend dev server and wait for readiness"],
+    [noOpen ? "skip" : "ready", "Window", noOpen ? "Do not launch the desktop window" : "Start the native host with the active project config"]
+  ])
+
+  if (dryRun) {
+    console.log("")
+    printSection("Dry run")
+    printStatusTable(
+      steps.length > 0
+        ? steps.map((step) => ["plan", step, "No processes will be started"])
+        : [["warn", "Nothing to do", "All dev phases were skipped"]]
+    )
+    return
+  }
+
+  if (steps.length === 0) {
+    console.log("")
+    printSection("Result")
+    printStatusTable([["warn", "Nothing to do", "All dev phases were skipped"]])
+    return
+  }
+
+  console.log("")
+  const progress = createProgress(steps.length, "Dev")
+
+  if (!skipRuntime) {
+    await buildFrameworkRuntime(frameworkPaths, frameworkBuildPaths, "dev", {
+      cwd: appPaths.appRoot,
+      dryRun
+    })
+    progress.tick("Native runtime built")
+  }
+
+  const children = []
+
+  if (!skipFrontend) {
+    const frontendProcess = spawnCommand(resolveNpmCommand(), [
+      "run",
+      "dev",
+      "--",
+      "--host",
+      devServer.host,
+      "--port",
+      devServer.port,
+      "--strictPort"
+    ], {
+      cwd: frontendDir,
+      dryRun
+    })
+
+    if (frontendProcess) {
+      children.push(frontendProcess)
+      await waitForUrl(config.frontend.devUrl)
+      progress.tick("Frontend dev server is reachable")
+    }
+  }
+
+  if (!noOpen) {
+    const appProcess = spawnCommand(frameworkBuildPaths.devAppBinary, [], {
+      cwd: appPaths.appRoot,
+      env: {
+        RESET_CONFIG_PATH: configPath,
+        RESET_FRONTEND_DEV_URL: config.frontend.devUrl
+      },
+      dryRun
+    })
+
+    if (appProcess) {
+      children.push(appProcess)
+      progress.tick("Desktop window launched")
+    }
+  }
+
+  if (children.length === 0) {
+    return
+  }
+
+  console.log("")
+  printSection("Runtime")
+  printStatusTable([
+    ["done", "Frontend", config.frontend.devUrl],
+    ["done", "Config", configPath]
+  ])
+  console.log("  Press Ctrl+C to stop")
+
+  const cleanup = registerChildCleanup(children)
+
+  try {
+    await Promise.race([
+      ...children.map((child, index) =>
+        waitForProcessExit(child, index === 0 ? "dev process" : "native host")
+      )
+    ])
+  } finally {
+    cleanup()
+  }
+}

package/src/commands/doctor.js

@@ -0,0 +1,89 @@
+import { existsSync } from "node:fs"
+
+import {
+  getAppChecks,
+  getFrameworkChecks,
+  loadResetConfig,
+  resolveFrontendDir,
+  resolveAppPaths,
+  resolveConfigPath,
+  resolveFrameworkPaths
+} from "../lib/project.js"
+import { findVcpkgToolchainFile } from "../lib/toolchain.js"
+import {
+  printBanner,
+  printKeyValueTable,
+  printSection,
+  printStatusTable
+} from "../lib/ui.js"
+
+export const description = "Inspect the current project layout"
+
+export async function run(context) {
+  const appPaths = resolveAppPaths(context.projectRoot)
+  const frameworkPaths = resolveFrameworkPaths()
+
+  let config = null
+
+  if (existsSync(resolveConfigPath(appPaths))) {
+    config = loadResetConfig(appPaths)
+  }
+
+  printBanner("reset-framework-cli doctor", description)
+
+  printSection("App project")
+
+  const appChecks = [...getAppChecks(appPaths)]
+  if (config) {
+    appChecks.unshift(["frontend", resolveFrontendDir(appPaths, config)])
+  }
+
+  printStatusTable(
+    appChecks.map(([label, filePath]) => [
+      existsSync(filePath) ? "ok" : "missing",
+      label,
+      filePath
+    ])
+  )
+
+  console.log("")
+  printSection("Framework installation")
+
+  printStatusTable(
+    getFrameworkChecks(frameworkPaths).map(([label, filePath]) => [
+      existsSync(filePath) ? "ok" : "missing",
+      label,
+      filePath
+    ])
+  )
+
+  console.log("")
+  printSection("Framework packages")
+  printKeyValueTable([
+    ["Native", `${frameworkPaths.frameworkPackage.packageName}@${frameworkPaths.frameworkPackage.version}`],
+    ["SDK", `${frameworkPaths.sdkPackage.packageName}@${frameworkPaths.sdkPackage.version}`],
+    ["Schema", `${frameworkPaths.schemaPackage.packageName}@${frameworkPaths.schemaPackage.version}`]
+  ])
+
+  console.log("")
+  printSection("Native toolchain")
+  const vcpkgToolchainFile = findVcpkgToolchainFile()
+  printStatusTable([
+    [vcpkgToolchainFile ? "ok" : "warn", "Framework source", frameworkPaths.frameworkRoot],
+    [vcpkgToolchainFile ? "ok" : "warn", "vcpkg toolchain", vcpkgToolchainFile ?? "Will be bootstrapped on first native build"]
+  ])
+
+  if (config) {
+    console.log("")
+    printSection("Config")
+    printKeyValueTable([
+      ["Name", config.name],
+      ["Product", config.productName],
+      ["App ID", config.appId],
+      ["Frontend", config.project.frontendDir],
+      ["Styling", config.project.styling],
+      ["Dev URL", config.frontend.devUrl],
+      ["Output", config.build.outputDir]
+    ])
+  }
+}