@epilot/cli 0.1.8 → 0.1.10

package/README.md

@@ -1,6 +1,19 @@
-# epilot CLI
+<h1 align="center"><img alt="epilot" src="https://raw.githubusercontent.com/epilot-dev/sdk-js/main/logo.png" width="200"><br>@epilot/cli</h1>
 
-CLI for epilot APIs. Call any epilot API operation directly from the command line.
+<p align="center">
+  <a href="https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI"><img src="https://github.com/epilot-dev/sdk-js/workflows/CI/badge.svg" alt="CI"></a>
+  <a href="https://www.npmjs.com/package/@epilot/cli"><img src="https://img.shields.io/npm/v/@epilot/cli.svg" alt="npm version"></a>
+  <a href="https://github.com/epilot-dev/sdk-js/blob/main/"><img src="http://img.shields.io/:license-mit-blue.svg" alt="License"></a>
+</p>
+
+<p align="center">Command-line interface for all epilot APIs. One command to call any operation.</p>
+
+Built for developers, automation scripts, and AI agents. The epilot CLI gives you direct access to the entire epilot platform from your terminal — no SDK setup, no boilerplate, just `npx epilot`.
+
+- **Quick API calls** — look up entities, search data, check configurations without writing code
+- **Automation & scripting** — pipe JSON in/out, `--json` mode for `jq`-friendly output, `--no-interactive` for CI
+- **AI agent tool use** — structured `--json` output and `--no-interactive` mode make it ideal as a tool for LLM agents and MCP servers
+- **Explore & discover** — interactive operation picker, `--guided` mode, and built-in help with sample requests/responses for every operation
 
 ## Install
 
@@ -16,7 +29,7 @@ npm install -g @epilot/cli
 
 <!-- usage-help -->
 ```
-epilot v0.1.8 — CLI for epilot APIs
+epilot v0.1.10 — CLI for epilot APIs
 
 USAGE
   epilot <api> <operationId> [params...] [flags]
@@ -247,12 +260,26 @@ epilot entity getEntity contact abc123  # automatically uses override
 
 When running in a TTY without required arguments, the CLI prompts interactively:
 
-- **No operation**: shows an operation picker
+- **No operation**: shows a searchable operation picker
 - **Missing required params**: prompts for each one
 - **No auth token**: prompts to paste a token
 
 Disable with `--no-interactive` for CI/scripts.
 
+### Guided Mode
+
+Use `--guided` to be prompted for **all** parameters, not just required ones. This is useful for exploring an API operation without having to look up every available parameter.
+
+```bash
+# Walk through all parameters for getEntity
+epilot entity getEntity --guided
+
+# Guided mode also opens the body editor for operations with a request body
+epilot entity searchEntities --guided
+```
+
+Each optional parameter shows "(optional, press Enter to skip)" so you can quickly skip ones you don't need.
+
 ## Shell Completions
 
 Tab completion for API names, operation IDs, and flags.

package/definitions/journey.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Journey API",
     "description": "API to configure journeys",
-    "version": "1.1.0"
+    "version": "1.4.0"
   },
   "security": [
     {
@@ -94,6 +94,9 @@
           {},
           {
             "EpilotAuth": []
+          },
+          {
+            "PortalAuth": []
           }
         ],
         "tags": [
@@ -299,7 +302,7 @@
             "schema": {
               "type": "string",
               "format": "Yn",
-              "example": true
+              "example": "true"
             }
           }
         ],
@@ -313,6 +316,16 @@
                 }
               }
             }
+          },
+          "400": {
+            "description": "Validation failed (when validation mode is STRICT)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/JourneyValidationError"
+                }
+              }
+            }
           }
         }
       },
@@ -347,6 +360,16 @@
               }
             }
           },
+          "400": {
+            "description": "Validation failed (when validation mode is STRICT)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/JourneyValidationError"
+                }
+              }
+            }
+          },
           "409": {
             "description": "The Journey has been modified since your last read, please refresh it and try again"
           }
@@ -389,6 +412,16 @@
               }
             }
           },
+          "400": {
+            "description": "Validation failed (when validation mode is STRICT)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/JourneyValidationError"
+                }
+              }
+            }
+          },
           "404": {
             "description": "Journey or associated entity not found",
             "content": {
@@ -505,7 +538,7 @@
             "schema": {
               "type": "string",
               "format": "Yn",
-              "example": true
+              "example": "true"
             }
           }
         ],
@@ -519,6 +552,16 @@
                 }
               }
             }
+          },
+          "400": {
+            "description": "Validation failed (when validation mode is STRICT)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/JourneyValidationError"
+                }
+              }
+            }
           }
         }
       },
@@ -551,6 +594,16 @@
               }
             }
           },
+          "400": {
+            "description": "Validation failed (when validation mode is STRICT)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/JourneyValidationError"
+                }
+              }
+            }
+          },
           "404": {
             "description": "Journey or associated entity not found",
             "content": {
@@ -606,6 +659,16 @@
               }
             }
           },
+          "400": {
+            "description": "Validation failed (when validation mode is STRICT)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/JourneyValidationError"
+                }
+              }
+            }
+          },
           "404": {
             "description": "Journey or associated entity not found",
             "content": {
@@ -896,16 +959,19 @@
               "type": "string"
             },
             "feature": {
-              "type": "array"
+              "type": "array",
+              "items": {}
             },
             "product_images": {
-              "type": "array"
+              "type": "array",
+              "items": {}
             },
             "legal_footnote": {
               "type": "string"
             },
             "product_downloads": {
-              "type": "array"
+              "type": "array",
+              "items": {}
             },
             "price": {
               "type": "object"
@@ -1166,7 +1232,8 @@
                               "type": "object"
                             },
                             {
-                              "type": "array"
+                              "type": "array",
+                              "items": {}
                             }
                           ]
                         },
@@ -1343,6 +1410,26 @@
                 "type": "string",
                 "nullable": true
               },
+              "addressSuggestionsCountryCode": {
+                "type": "string",
+                "nullable": true,
+                "description": "Country code for address format (e.g. DE, AT, CH, LU)"
+              },
+              "addressSuggestionsEnableAutoComplete": {
+                "type": "boolean",
+                "description": "Whether address auto-complete is enabled"
+              },
+              "addressSuggestionsSource": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)"
+              },
+              "addressSuggestionsEnableFreeText": {
+                "type": "boolean",
+                "description": "Whether free text input is allowed when auto-complete is on"
+              },
               "useNewDesign": {
                 "type": "boolean",
                 "deprecated": true,
@@ -1652,7 +1739,8 @@
                               "type": "object"
                             },
                             {
-                              "type": "array"
+                              "type": "array",
+                              "items": {}
                             }
                           ]
                         },
@@ -1817,6 +1905,26 @@
                 "type": "string",
                 "nullable": true
               },
+              "addressSuggestionsCountryCode": {
+                "type": "string",
+                "nullable": true,
+                "description": "Country code for address format (e.g. DE, AT, CH, LU)"
+              },
+              "addressSuggestionsEnableAutoComplete": {
+                "type": "boolean",
+                "description": "Whether address auto-complete is enabled"
+              },
+              "addressSuggestionsSource": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)"
+              },
+              "addressSuggestionsEnableFreeText": {
+                "type": "boolean",
+                "description": "Whether free text input is allowed when auto-complete is on"
+              },
               "useNewDesign": {
                 "type": "boolean",
                 "deprecated": true,
@@ -2042,6 +2150,140 @@
           "revisions"
         ]
       },
+      "JourneyValidationResponse": {
+        "type": "object",
+        "properties": {
+          "valid": {
+            "type": "boolean",
+            "description": "Whether the journey configuration is valid"
+          },
+          "errors": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "description": "Pattern type (e.g. PatternA_DotsInStepId)"
+                },
+                "severity": {
+                  "type": "string",
+                  "enum": [
+                    "critical",
+                    "high",
+                    "medium",
+                    "low"
+                  ]
+                },
+                "message": {
+                  "type": "string"
+                },
+                "affectedStepIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "count": {
+                  "type": "integer"
+                },
+                "autoFix": {
+                  "type": "object",
+                  "properties": {
+                    "feasible": {
+                      "type": "boolean"
+                    },
+                    "confidence": {
+                      "type": "string",
+                      "enum": [
+                        "high",
+                        "medium",
+                        "low"
+                      ]
+                    },
+                    "reason": {
+                      "type": "string"
+                    },
+                    "details": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            },
+            "description": "List of detected validation errors"
+          },
+          "warnings": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string"
+                },
+                "message": {
+                  "type": "string"
+                }
+              }
+            },
+            "description": "List of warnings (non-critical issues)"
+          }
+        },
+        "required": [
+          "valid",
+          "errors"
+        ]
+      },
+      "JourneyValidationError": {
+        "type": "object",
+        "properties": {
+          "error": {
+            "type": "string",
+            "example": "ValidationError",
+            "description": "Error type identifier"
+          },
+          "message": {
+            "type": "string",
+            "example": "Journey configuration validation failed",
+            "description": "High-level error message"
+          },
+          "details": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "pattern": {
+                  "type": "string",
+                  "description": "Validation pattern that failed"
+                },
+                "severity": {
+                  "type": "string",
+                  "enum": [
+                    "critical",
+                    "high",
+                    "medium",
+                    "low"
+                  ]
+                },
+                "message": {
+                  "type": "string",
+                  "description": "Detailed error message"
+                },
+                "count": {
+                  "type": "integer",
+                  "description": "Number of issues found"
+                }
+              }
+            },
+            "description": "Detailed validation errors for each pattern that failed"
+          }
+        },
+        "required": [
+          "error",
+          "message",
+          "details"
+        ]
+      },
       "S3Reference": {
         "type": "object",
         "properties": {
@@ -2124,7 +2366,7 @@
             "description": "The file entity id, used when persisting a new template version with updated settings",
             "type": "string",
             "format": "uuid",
-            "example": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
+            "example": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
           }
         }
       },
@@ -2327,13 +2569,16 @@
         "scheme": "bearer",
         "description": "Epilot Authorization Bearer Token - public access token / user token",
         "bearerFormat": "JWT"
+      },
+      "PortalAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "description": "Portal Authorization Bearer Token",
+        "bearerFormat": "JWT"
       }
     }
   },
   "servers": [
-    {
-      "url": "https://journey-config.sls.epilot.io"
-    },
     {
       "url": "https://journey-config.sls.epilot.io"
     }