@plurnk/plurnk-execs-common 0.2.3 → 0.2.4

package/docs/node.md

@@ -0,0 +1,15 @@
+# node
+
+A JavaScript snippet, run via `node -e`. Node is the daemon's own runtime, so it's always available (no PATH probe).
+
+## Environment
+
+The same scoped environment as `sh`: the daemon's own secrets (`PLURNK_*`, provider keys) are stripped, so `process.env` inside the snippet sees the project's environment, not plurnk's.
+
+## Output
+
+Whatever the snippet writes to stdout streams to the `stdout` channel (stderr → `stderr`); both are text. To return structured data, `console.log(JSON.stringify(x))` and `READ` it back. A thrown error exits non-zero (status 500) with the stack on `stderr`.
+
+## Working directory
+
+Runs in the session project root by default; `EXEC[node](./dir):…` sets cwd, and relative `import` / `require` / `fs` paths resolve against it.

package/docs/sh.md

@@ -0,0 +1,15 @@
+# sh
+
+A shell command line, run via `sh -c`. Bare `EXEC` (no runtime tag) defaults to `sh`, so `<<EXEC:ls -la:EXEC` and `<<EXEC[sh]:ls -la:EXEC` are equivalent.
+
+## Environment
+
+The command runs with a **scoped** environment: the host daemon's own secrets — provider API keys and every `PLURNK_*` config var — are stripped before the child sees them, so `printenv` / `env` cannot read plurnk's credentials. The project's own environment passes through unchanged.
+
+## Working directory
+
+`EXEC[sh](./dir):…` runs in `./dir`. With no target the command runs in the session's project root — the same place the `file` scheme writes — so it finds files a prior `EDIT` just created, rather than the daemon's cwd.
+
+## Channels
+
+Output streams into two channels on the `exec://` entry: `#stdout` (default) and `#stderr` (both `text/stream`); `READ` the entry to see them. A host-effecting command proposes for review before it runs; a read-only one runs inline and returns its output the same turn. A non-zero exit closes the entry with status 500, the message on `stderr`.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@plurnk/plurnk-execs-common",
-    "version": "0.2.3",
+    "version": "0.2.4",
     "description": "Universal subprocess executor for plurnk-service's exec scheme — one package exposing the shell + node + python floor plus whichever host interpreters (perl, ruby, php, lua, awk, bc, …) are present.",
     "keywords": [
         "plurnk",
@@ -35,7 +35,8 @@
         "runtimes": [
             {
                 "name": "sh",
-                "glyph": "🐚"
+                "glyph": "🐚",
+                "example": "EXEC:chmod +x ./example.sh && ./example.sh:EXEC"
             },
             {
                 "name": "bash",
@@ -43,7 +44,8 @@
             },
             {
                 "name": "node",
-                "glyph": "⬢"
+                "glyph": "⬢",
+                "example": "EXEC[node]:console.log(new Date(Date.now() + 14 * 86_400_000).toISOString().slice(0, 10)):EXEC"
             },
             {
                 "name": "python",
@@ -107,7 +109,8 @@
     "files": [
         "dist/**/*",
         "README.md",
-        ".env.example"
+        ".env.example",
+        "docs/**/*"
     ],
     "scripts": {
         "test:lint": "tsc --noEmit",