create-kosh-erp 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Isahaq
+
+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 whom the Software is
+furnished 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

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# create-kosh-erp
 
-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.
+Install [Kosh](https://www.npmjs.com/package/kosh-erp) and set it up in one command:
+
+```sh
+npm create kosh-erp@latest my-erp
+```
+
+It creates the folder, installs `kosh-erp` (Shutro comes with it), then asks for:
+
+- the PostgreSQL database (your server, or one started in Docker for you; a missing database is created)
+- the company (name, currency, language, time zone)
+- the administrator (login, name, email, password) and its authenticator app
+- the apps (roles and approvals, reports and documents, chatter and attachments)
+- file storage (a folder or S3), Valkey (optional), the API port
+
+and sets everything up: the project files and `.env`, the database tables, the administrator, the seed data, and
+the back-office's build tools. Then:
+
+```sh
+cd my-erp
+npm start        # the API
+npm run web      # the back-office → http://localhost:5173
+```
+
+Options for `kosh init` go after `--`:
+
+```sh
+npm create kosh-erp@latest my-erp -- --docker-db
+npm create kosh-erp@latest my-erp -- --yes --database-url postgres://user:pass@localhost:5432/my_erp \
+  --create-database --company "Padma Traders" --admin-password "a long passphrase here"
+```
+
+`pnpm create kosh-erp` and `yarn create kosh-erp` work too. The full guide (Docker, modules, migrations, seed data,
+users, every command) is on the [kosh-erp page](https://www.npmjs.com/package/kosh-erp).
+
+## Author
+
+**Isahaq**, hmisahaq01@gmail.com, mobile +8801852376598
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,126 @@
+#!/usr/bin/env node
+/**
+ * `npm create kosh-erp@latest [folder] [-- kosh init options]`: a complete Kosh installation in one command.
+ *
+ * 1. creates the folder and a package.json (or uses the existing one),
+ * 2. installs kosh-erp (Shutro comes with it) with the package manager that ran this,
+ * 3. runs `kosh init`, which asks for the database, the company, the administrator, the apps, file storage and
+ *    the port, then creates the database tables, the administrator and the seed data,
+ * 4. installs what the project needs next (the back-office's build tools),
+ * 5. prints how to start it.
+ *
+ * Plain JavaScript without dependencies: it runs before anything is installed.
+ */
+import { spawnSync } from 'node:child_process';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { basename, join, resolve } from 'node:path';
+import { createInterface } from 'node:readline/promises';
+
+const own = JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf8'));
+/** What to install: kosh-erp of the same minor version (KOSH_ERP_SPEC overrides it, e.g. a local tarball). */
+const [major, minor] = own.version.split('.');
+const spec = process.env.KOSH_ERP_SPEC ?? `kosh-erp@^${major}.${minor}.0`;
+
+// `npm create kosh-erp my-erp -- --yes …` reaches us without the `--` (npm consumes it); `npx create-kosh-erp`
+// keeps it. Either way: an optional folder first, everything else is for kosh init.
+const argv = process.argv.slice(2).filter((a, i, all) => !(a === '--' && all.indexOf('--') === i));
+const positional = argv[0] !== undefined && !argv[0].startsWith('-') ? argv[0] : undefined;
+const forInit = positional === undefined ? argv : argv.slice(1);
+
+if (forInit.length === argv.length && (argv[0] === '--help' || argv[0] === '-h')) {
+  process.stdout.write(`Usage: npm create kosh-erp@latest [folder] [-- kosh init options]
+
+Creates a Kosh installation in [folder]: installs kosh-erp, then asks for the database, the company, the
+administrator, the apps, file storage and the port, and sets everything up.
+
+Examples:
+  npm create kosh-erp@latest my-erp
+  npm create kosh-erp@latest my-erp -- --docker-db
+  npm create kosh-erp@latest my-erp -- --yes --database-url postgres://… --admin-password "…"
+`);
+  process.exit(0);
+}
+
+/** The package manager that ran us (npm create, pnpm create, yarn create). */
+const agent = process.env.npm_config_user_agent ?? '';
+const pm = agent.startsWith('pnpm') ? 'pnpm' : agent.startsWith('yarn') ? 'yarn' : 'npm';
+/**
+ * Runs a command in this terminal. The package manager is a .cmd script on Windows and needs a shell there, so its
+ * arguments are quoted; Node itself runs without one (its path may contain spaces: C:\Program Files\nodejs).
+ */
+const run = (command, args, cwd, env = {}) => {
+  const options = { cwd, stdio: 'inherit', env: { ...process.env, ...env } };
+  if (command === process.execPath || process.platform !== 'win32')
+    return spawnSync(command, args, options).status ?? 1;
+  // One command line, each part quoted when it needs it (the shell gets no separate argument list).
+  const quote = (a) => (/[\s"&|<>^]/.test(a) ? `"${a.replace(/"/g, '\\"')}"` : a);
+  return (
+    spawnSync([command, ...args].map(quote).join(' '), { ...options, shell: true }).status ?? 1
+  );
+};
+const add = (cwd, what) =>
+  run(pm, pm === 'npm' ? ['install', '--no-audit', '--no-fund', ...what] : ['add', ...what], cwd);
+const installAll = (cwd) =>
+  run(pm, pm === 'npm' ? ['install', '--no-audit', '--no-fund'] : ['install'], cwd);
+
+async function folder() {
+  if (positional !== undefined) return positional;
+  if (!process.stdin.isTTY) return 'my-erp';
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  const answer = (await rl.question('Project folder [my-erp]: ')).trim();
+  rl.close();
+  return answer === '' ? 'my-erp' : answer;
+}
+
+const target = resolve(await folder());
+const name =
+  basename(target)
+    .toLowerCase()
+    .replace(/[^a-z0-9-]+/g, '-') || 'kosh-app';
+process.stdout.write(`\nCreating a Kosh installation in ${target}\n\n`);
+mkdirSync(target, { recursive: true });
+if (!existsSync(join(target, 'package.json')))
+  writeFileSync(
+    join(target, 'package.json'),
+    `${JSON.stringify({ name, version: '0.1.0', private: true, type: 'module' }, null, 2)}\n`,
+  );
+
+process.stdout.write(`Installing ${spec} …\n`);
+if (add(target, [spec]) !== 0) {
+  process.stderr.write(`\nInstalling ${spec} failed (see above).\n`);
+  process.exit(1);
+}
+
+const cli = join(target, 'node_modules', 'kosh-erp', 'dist', 'cli', 'bin.js');
+if (!existsSync(cli)) {
+  process.stderr.write(`\n${cli} is missing: the kosh-erp installation is incomplete.\n`);
+  process.exit(1);
+}
+process.stdout.write('\n');
+// kosh init asks its questions in this terminal (stdio inherited), then sets up the database.
+const init = run(process.execPath, [cli, 'init', '.', ...forInit], target, { KOSH_CREATE: '1' });
+if (init !== 0) {
+  process.stderr.write(
+    `\nThe setup stopped. Fix the problem above, then finish it with:\n  cd ${positional ?? basename(target)}\n  npx kosh init\n`,
+  );
+  process.exit(init);
+}
+
+process.stdout.write('\nInstalling the back-office tools …\n');
+if (installAll(target) !== 0) {
+  process.stderr.write(`\n${pm} install failed (see above); run it again in ${target}.\n`);
+  process.exit(1);
+}
+
+const cd = target === resolve('.') ? '' : `  cd ${positional ?? basename(target)}\n`;
+const start = pm === 'npm' ? 'npm start' : `${pm} start`;
+const web = pm === 'npm' ? 'npm run web' : `${pm} web`;
+process.stdout.write(`
+Kosh is installed.
+
+${cd}  ${start}            # the API (reads .env)
+  ${web}          # the back-office, in a second terminal → http://localhost:5173
+
+Everything in Docker instead:  docker compose up -d --build   → http://localhost:8080
+Guide: https://www.npmjs.com/package/kosh-erp
+`);

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "create-kosh-erp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.2",
+  "description": "npm create kosh-erp: install Kosh and set it up in one command (database, company, administrator, apps, port)",
+  "keywords": [
+    "kosh",
+    "kosh-erp",
+    "erp",
+    "create",
+    "starter",
+    "postgresql"
+  ],
+  "author": {
+    "name": "Isahaq",
+    "email": "hmisahaq01@gmail.com"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/isahaq1/kosh#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/isahaq1/kosh.git",
+    "directory": "packages/create-kosh-erp"
+  },
+  "bugs": {
+    "url": "https://github.com/isahaq1/kosh/issues"
+  },
+  "type": "module",
+  "bin": {
+    "create-kosh-erp": "index.js"
+  },
+  "files": [
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=24"
+  }
+}