@groundfloorcloud/cli 0.1.2 → 0.1.3

package/README.md

@@ -54,15 +54,28 @@ curl -H "Authorization: Bearer $(gf token)" \
 create if needed, upload a version, wait for the build, deploy, poll until
 complete, and print IDs and the URL.
 
-Do not create an App just to run a function, job, schedule, or service.
-Use `gf deploy`. Bind `--app-id` only when the coderunner should be a helper
-of an existing product App.
+Do not create an App just to run a function, job, schedule, or service
+(Deployment). Use `gf deploy`. Bind `--app-id` only when the coderunner should
+be a helper of an existing product App.
+
+**Before the first create:** enable workspace Authentication (Administer →
+Authentication, mode `groundfloor` or `external`) until the realm is active.
+
+### Workload types
+
+| `--workload-type` | Also called | Package notes |
+|-------------------|-------------|---------------|
+| `function` | Function | HTTP on `PORT`/8080. Node needs `scripts.start`. |
+| `job` | Background job | Run-to-completion. Then `gf coderunner run`. |
+| `schedule` | Scheduled job | Cron. No public URL. |
+| `service` | **Deployment** | Long-running HTTP. **Root `Dockerfile` is required.** |
 
 ```bash
 gf deploy
 gf deploy --git https://github.com/me/my-fn.git --ref main
 gf deploy --name my-fn --runtime python --cpu 250m --memory 256Mi \
   -e API_KEY=secret
+gf deploy --workload-type service
 gf deploy --app-id <app-uuid>
 ```
 
@@ -75,6 +88,19 @@ How the target is chosen:
 
 Runtime is auto-detected when omitted (`package.json` → node,
 `requirements.txt` / `pyproject.toml` → python), defaulting to python.
+Node images run `npm start` — add `"scripts": { "start": "node index.js" }`.
+
+### Local with live data
+
+```bash
+eval "$(gf env)"
+export PORT=8080
+npm start
+curl -sS -H "Authorization: Bearer $(gf token)" \
+  "$CONTROLPLANE_URL/v1/workspaces/$GROUNDFLOOR_WORKSPACE_ID/vault/collections"
+```
+
+Then `gf deploy` the same tree. Do not zip `.env` files.
 
 ### `groundfloor.json`
 
@@ -98,7 +124,7 @@ Runtime is auto-detected when omitted (`package.json` → node,
 | `--git <url>` / `--ref <ref>` | Clone and deploy a remote repo. |
 | `--subdir <dir>` | Package a subdirectory of the source. |
 | `--runtime <r>` | `python` \| `node` \| `dotnet-script`. |
-| `--workload-type <t>` | `function` \| `service` \| `job` \| `schedule`. |
+| `--workload-type <t>` | `function` \| `service` (Deployment) \| `job` \| `schedule`. Service requires a Dockerfile. |
 | `--cpu` / `--memory` | Resource requests, e.g. `250m` / `256Mi`. |
 | `-e, --env KEY=VALUE` | Deployment env var (repeatable). |
 | `-m, --message <text>` | Version description. |

package/dist/index.js

@@ -1239,6 +1239,33 @@ async function deployCommand(opts) {
         `Invalid workload type "${workloadType}" (expected: ${[...WORKLOAD_TYPES].join(", ")}).`
       );
     }
+    if (workloadType === "service") {
+      try {
+        await fs3.access(path3.join(pkg.sourceDir, "Dockerfile"));
+      } catch {
+        throw new Error(
+          'workload type "service" (also called Deployment) requires a Dockerfile at the project root.'
+        );
+      }
+    }
+    if (runtime === "node") {
+      try {
+        const raw = await fs3.readFile(
+          path3.join(pkg.sourceDir, "package.json"),
+          "utf8"
+        );
+        const npm = JSON.parse(raw);
+        if (!npm.scripts?.start?.trim()) {
+          throw new Error(
+            'Node Coderunner packages require package.json "scripts.start" (runtime CMD is npm start).'
+          );
+        }
+      } catch (err) {
+        if (err instanceof Error && err.message.includes("scripts.start")) {
+          throw err;
+        }
+      }
+    }
     let coderunnerId = opts.coderunner;
     if (!coderunnerId) {
       const name = opts.name ?? manifest.name ?? (opts.git ? nameFromGitUrl(opts.git) : path3.basename(path3.resolve(opts.path ?? process.cwd())));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groundfloorcloud/cli",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Groundfloor gf CLI — sign in, deploy coderunners, publish Shell apps, and manage secrets, files, and Dataplane.",
   "type": "module",
   "bin": {