@vantail/cli 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,77 @@
+# @vantail/cli
+
+The command line for [Vantail](https://github.com/Vantail/vantail): run an
+application in a native window, and turn it into something people can install.
+
+```bash
+npm create @vantail my-app
+```
+
+The scaffolder installs this for you. Otherwise:
+
+```bash
+npm install --save-dev @vantail/cli
+```
+
+## Commands
+
+```bash
+vantail dev        # native window against the Vite dev server, with HMR
+vantail build      # build the web assets
+vantail package    # lay out a distributable application
+vantail doctor     # check that everything needed to run is present
+vantail updater    # keygen | sign | manifest
+```
+
+`vantail dev` starts Vite, points a real webview at it, and ties their
+lifetimes together: close the window and the server stops, stop the CLI and
+the window closes. Editing the config reopens the window, since window size
+and permissions are read once at startup.
+
+`vantail package` produces a `.app` on macOS and a portable folder elsewhere.
+It copies a precompiled runtime binary; there is no compilation step and no
+Rust toolchain involved. Add `--installer` for the thing a user downloads: a
+`.dmg` on macOS, an `.msi` on Windows, a `.deb` on Linux.
+
+`vantail doctor` prints which runtime it found and why, which is the first
+thing to run when something will not start.
+
+## Configuration
+
+`defineConfig` is exported from here, so the config file is typed:
+
+```ts
+// vantail.config.ts
+import { defineConfig } from "@vantail/cli";
+
+export default defineConfig({
+  app: {
+    name: "My App",
+    identifier: "dev.example.myapp",
+    version: "1.0.0",
+    // One square PNG. Every size each platform asks for is scaled from it.
+    icon: "icon.png",
+  },
+
+  window: { width: 1200, height: 800 },
+
+  permissions: {
+    dialog: true,
+    filesystem: {
+      read: ["$DOCUMENT/**"],
+      write: ["$APPDATA/**"],
+    },
+  },
+});
+```
+
+Nothing native is available until the config asks for it. `$DOCUMENT`,
+`$APPDATA` and the rest resolve to the right directory per platform.
+
+## Documentation
+
+- [Configuration and permissions](https://github.com/Vantail/vantail/blob/main/docs/permissions.md)
+- [Bundles, installers and signing](https://github.com/Vantail/vantail/blob/main/docs/packaging.md)
+- [Shipping updates](https://github.com/Vantail/vantail/blob/main/docs/updater.md)
+
+MIT licensed.

package/dist/index.d.ts

@@ -13,7 +13,7 @@ export { packageApp, type PackageOptions } from "./commands/package.js";
 export { bundle, type BundleInput, type BundleResult } from "./bundle/index.js";
 export { buildRuntimeConfig, type RuntimeConfigInput } from "./runtime-config.js";
 /** Kept in step with package.json by the release script. */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";
 /** `ConfigError` is thrown from a package the CLI does not re-export. */
 export declare const ConfigErrorName = "ConfigError";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -12,7 +12,7 @@ export { packageApp } from "./commands/package.js";
 export { bundle } from "./bundle/index.js";
 export { buildRuntimeConfig } from "./runtime-config.js";
 /** Kept in step with package.json by the release script. */
-export const VERSION = "0.1.0";
+export const VERSION = "0.1.1";
 /** `ConfigError` is thrown from a package the CLI does not re-export. */
 export const ConfigErrorName = "ConfigError";
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vantail/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The Vantail command line: dev, build, package.",
   "license": "MIT",
   "repository": {
@@ -27,9 +27,9 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@vantail/runtime": "^0.1.0",
-    "@vantail/shared": "^0.1.0",
-    "@vantail/vite": "^0.1.0"
+    "@vantail/runtime": "^0.1.1",
+    "@vantail/shared": "^0.1.1",
+    "@vantail/vite": "^0.1.1"
   },
   "peerDependencies": {
     "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"