create-inkan 0.0.0-stage → 0.9.0

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# create-inkan
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+```sh
+npm create inkan@latest
+npm create inkan@latest my-api -- --store postgres --auth --frontend next
+```
+
+A new [inkan](https://github.com/inkanjs/inkan) app: routes with contracts and examples, a
+store (memory, Postgres, Redis, MongoDB or MySQL), logins from `@inkanjs/auth` if you want
+them, a Next.js or Vite frontend if you want one, tests and a CI workflow. Every project
+passes `inkan check` and its own tests as it comes.
+
+It asks what it needs. Options skip the questions:
+
+| option | |
+| --- | --- |
+| `--store memory\|postgres\|redis\|mongo\|mysql` | where the data lives (memory) |
+| `--auth`, `--no-auth` | logins and sessions (no) |
+| `--frontend none\|next\|vite` | a frontend with the API under `/api` (none) |
+| `--pm npm\|pnpm\|yarn\|bun` | who installs (the one that ran this) |
+| `--no-install` | write the files only |
+| `--yes` | the defaults for everything the options leave open |
+| `--force` | write into a folder that is not empty |
+
+This package is `inkan create app` of `@vxnsin/inkan` at the same version; with inkan
+installed, `npx inkan create app` does the same.

package/index.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+// npm create inkan [folder] -- [options]: hands everything to `inkan create app` of the
+// @vxnsin/inkan this package depends on, at its own version, so the templates and the
+// CLI that writes them always match. The work is all there; this only finds it.
+
+import { spawnSync } from "node:child_process";
+import { readFileSync } from "node:fs";
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+
+const CORE = "@vxnsin/inkan";
+
+const require = createRequire(import.meta.url);
+const manifest = require.resolve(`${CORE}/package.json`);
+const { bin } = JSON.parse(readFileSync(manifest, "utf8"));
+const cli = join(dirname(manifest), typeof bin === "string" ? bin : bin.inkan);
+
+const r = spawnSync(process.execPath, [cli, "create", "app", ...process.argv.slice(2)], { stdio: "inherit" });
+if (r.error) {
+  console.error(`create-inkan: could not start ${CORE}: ${r.error.message}`);
+  process.exit(1);
+}
+process.exit(r.status ?? 1);

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "create-inkan",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.9.0",
+  "description": "npm create inkan: a new inkan app with a store, auth, a frontend, tests and CI, from the inkan of the same version.",
+  "keywords": [
+    "inkan",
+    "create",
+    "starter",
+    "api",
+    "openapi"
+  ],
+  "license": "MIT",
+  "author": "Vensin (https://github.com/vxnsin)",
+  "homepage": "https://github.com/inkanjs/inkan#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inkanjs/inkan.git",
+    "directory": "create"
+  },
+  "type": "module",
+  "bin": {
+    "create-inkan": "./index.js"
+  },
+  "files": [
+    "index.js"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "@vxnsin/inkan": "0.9.0"
+  }
+}