@openfn/cli 1.1.1 → 1.1.2

package/README.md

@@ -192,6 +192,8 @@ Example config file:
 
   // Optional: defaults to OpenFn.org's API, can be overridden or set with
   // `OPENFN_ENDPOINT` env var
+  // If you're running Lightning locally, you may need to use your local IP address (e.g., 127.0.0.1) instead of localhost,
+  // depending on the version of Node.js and your system.
   "endpoint": "https://app.openfn.org"
 }
 ```

package/dist/index.js

@@ -564,8 +564,8 @@ Remember to include the adaptor name with -a. Auto install adaptors with the -i
     "openfn foo/job.js",
     "Execute foo/job.js with no adaptor and write the final state to foo/job.json"
   ).example(
-    "openfn workflow.json -i",
-    "Execute workflow.json with autoinstall enabled"
+    "openfn workflow.json",
+    "Execute the workflow contained in workflow.json"
   ).example(
     "openfn job.js -a common --log info",
     "Execute job.js with common adaptor and info-level logging"

package/dist/process/runner.js

@@ -476,6 +476,7 @@ var loadJson = async (workflowPath, logger) => {
   let text;
   try {
     text = await fs2.readFile(workflowPath, "utf8");
+    logger.debug("Loaded workflow from", workflowPath);
   } catch (e) {
     return abort_default(
       logger,
@@ -558,6 +559,7 @@ var fetchFile = async (jobId, rootDir = "", filePath, log) => {
   try {
     const fullPath = filePath.startsWith("~") ? filePath : path2.resolve(rootDir, filePath);
     const result = await fs2.readFile(fullPath, "utf8");
+    log.debug("Loaded file", fullPath);
     return result;
   } catch (e) {
     abort_default(
@@ -899,31 +901,29 @@ var handler_default5 = docgenHandler;
 
 // src/docs/handler.ts
 import { readFile as readFile2 } from "node:fs/promises";
+import c from "chalk";
 import { getNameAndVersion as getNameAndVersion4, getLatestVersion } from "@openfn/runtime";
-var describeFn = (adaptorName, fn) => `## ${fn.name}(${fn.parameters.map(({ name }) => name).join(",")})
-
-${fn.description}
-
-### Usage Examples
-
-${fn.examples.length ? fn.examples.map(({ code, caption }) => {
-  if (caption) {
-    return `${caption}:
+var describeFn = (adaptorName, fn) => [
+  c.green(`## ${fn.name}(${fn.parameters.map(({ name }) => name).join(",")})`),
+  `${fn.description}`,
+  c.green("### Usage Examples"),
+  fn.examples.length ? fn.examples.map(({ code, caption }) => {
+    if (caption) {
+      return `${caption}:
 ${code}`;
-  }
-  return code;
-}).join("\n\n") : "None"}
-
-### API Reference
-
-https://docs.openfn.org/adaptors/packages/${adaptorName.replace(
-  "@openfn/language-",
-  ""
-)}-docs#${fn.name}
-`;
-var describeLib = (adaptorName, data) => `## ${adaptorName} ${data.version}
+    }
+    return code;
+  }).join("\n\n") : "None",
+  c.green("### API Reference"),
+  `https://docs.openfn.org/adaptors/packages/${adaptorName.replace(
+    "@openfn/language-",
+    ""
+  )}-docs#${fn.name}
+`
+].join("\n\n");
+var describeLib = (adaptorName, data) => c.green(`## ${adaptorName} ${data.version}`) + `
 
-${data.functions.map((fn) => `  ${fn.name}(${fn.parameters.map((p) => p.name).join(", ")})`).sort().join("\n")}
+${data.functions.map((fn) => `  ${c.yellow(fn.name)} (${fn.parameters.map((p) => p.name).join(", ")})`).sort().join("\n")}
 `;
 var docsHandler = async (options, logger) => {
   const { adaptor, operation, repoDir } = options;
@@ -954,21 +954,27 @@ var docsHandler = async (options, logger) => {
       const fn = data.functions.find(({ name: name2 }) => name2 === operation);
       if (fn) {
         logger.debug("Operation schema:", fn);
-        logger.success(`Documentation for ${name}.${operation} v${version}:
-`);
+        logger.break();
         desc = describeFn(name, fn);
       } else {
         logger.error(`Failed to find ${operation} in ${name}`);
       }
     } else {
-      logger.debug("No operation provided, listing available operations");
+      logger.debug("No operation name provided");
+      logger.always("Available functions:\n");
       desc = describeLib(name, data);
     }
     logger.print(desc);
+    if (!operation) {
+      logger.always(`For more details on a specfic functions, use:
+    
+    openfn docs ${name} <fn>
+`);
+    }
     if (didError) {
       logger.error("Error");
     } else {
-      logger.success("Done!");
+      logger.info("Done!");
     }
   } else {
     logger.error("Not found");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",
@@ -46,10 +46,10 @@
     "treeify": "^1.1.0",
     "yargs": "^17.7.2",
     "@openfn/compiler": "0.0.41",
-    "@openfn/deploy": "0.4.3",
     "@openfn/describe-package": "0.0.18",
-    "@openfn/logger": "1.0.1",
-    "@openfn/runtime": "1.1.1"
+    "@openfn/runtime": "1.1.1",
+    "@openfn/deploy": "0.4.4",
+    "@openfn/logger": "1.0.1"
   },
   "files": [
     "dist",