@stackone/cli 1.9.3 → 1.10.1

package/README.md

@@ -111,6 +111,138 @@ Options:
 
 Note: The file extension of a connector file needs to be `.s1.yaml`. The file extension can be omitted.
 
+### `run`
+
+Execute a connector action locally with full control over connector configuration, account details, and execution parameters. This command is ideal for testing and debugging connectors during development.
+
+```bash
+stackone run --connector path/to/connector.s1.yaml --account-id <account-id> --profile <profile-label>
+```
+
+**Options:**
+
+- `--connector <connector>` - Path to the connector file to run, or inline connector YAML string
+- `--action <action>` - Path to an action file or inline action YAML code to add to the connector
+- `--action-id <action-id>` - Specific action ID to execute. If not provided, the last action in the connector will be executed
+- `--account <account>` - Path to a JSON file with account details or inline JSON string (see Account Format below)
+- `--account-id <account-id>` - Account ID to fetch from StackOne API (requires `--profile`)
+- `--params <params>` - Path to a JSON file with action parameters or inline JSON string (see Parameters Format below)
+- `--credentials <credentials>` - Path to a JSON file with credentials or inline JSON string (see Credentials Format below)
+- `-p, --profile <label>` - Configuration profile to use (required when using `--account-id`)
+- `-o, --output-file <output-file>` - File path to write the execution output to (JSON format)
+- `-d, --debug` - Enable debug mode to include execution steps and detailed information in the output
+
+**Usage Examples:**
+
+1. **Run with account from API:**
+
+   ```bash
+   stackone run --connector connector.s1.yaml --account-id acc_123 --profile production
+   ```
+
+2. **Run with local account file & credentials:**
+
+   ```bash
+   stackone run --connector connector.s1.yaml --account account.json --credentials credentials.json
+   ```
+
+3. **Run with inline account data:**
+
+   ```bash
+   stackone run --connector connector.s1.yaml --account '{"auth_config_key":"basic","credentials":{"username":"user","password":"pass"}}'
+   ```
+
+4. **Run specific action with parameters:**
+
+   ```bash
+   stackone run --connector connector.s1.yaml --action-id list_employees --account-id acc_123 --profile production --params params.json
+   ```
+
+5. **Run with custom action file:**
+
+   ```bash
+   stackone run --connector connector.s1.yaml --action custom-action.yaml --account account.json
+   ```
+
+6. **Run with debug mode and output to file:**
+
+   ```bash
+   stackone run --connector connector.s1.yaml --account-id acc_123 --profile production --debug --output-file result.json
+   ```
+
+**Account Format** (JSON):
+
+When using `--account` with a file or inline JSON, use this structure:
+
+```json
+{
+  "auth_config_key": "basic",
+  "environment": "production",
+  "organization_id": "org_123",
+  "account_id": "acc_456",
+  "project_id": "proj_789"
+}
+```
+
+All fields are optional except for `auth_config_key`.
+
+**Credentials Format** (JSON):
+
+When using `--credentials`, provide a key-value object:
+
+```json
+{
+  "api_key": "your_api_key",
+  "username": "your_username",
+  "password": "your_password"
+}
+```
+
+Note: Credentials provided via `--credentials` will merge with and override credentials from `--account` or `--account-id`.
+
+**Parameters Format** (JSON):
+
+When using `--params`, provide parameters for path, query, headers, and body:
+
+```json
+{
+  "path": {
+    "id": "employee_123"
+  },
+  "queryParams": {
+    "page": "1",
+    "page_size": "10"
+  },
+  "header": {
+    "X-Custom-Header": "value"
+  },
+  "body": {
+    "name": "John Doe",
+    "email": "john@example.com"
+  }
+}
+```
+
+All fields are optional and default to empty objects `{}`.
+
+**Requirements:**
+
+- Either `--account` or `--account-id` must be provided
+- When using `--account-id`, the `--profile` option is required
+- When using `--action`, the `--connector` option is required
+- A valid connector is required (via `--connector` or inferred from action)
+
+**Features:**
+
+- **Flexible connector loading**: Load from file path or provide inline YAML
+- **Dynamic action injection**: Add custom actions to existing connectors on-the-fly
+- **Multiple authentication methods**: Use API-fetched accounts or local account data
+- **Credential override**: Merge or override credentials at runtime
+- **Comprehensive parameters**: Support for path params, query params, headers, and body
+- **Debug mode**: Get detailed execution information including step-by-step processing
+- **Output redirection**: Save results to file for further processing or analysis
+- **Error handling**: Clear error messages with execution details when actions fail
+
 ### `version`
 
 Show CLI version information. If a new version is available, it will prompt you to update:

package/dist/chunk-DEHCWMz8.cjs

@@ -0,0 +1 @@
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),s=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},c=(n,r,a)=>(a=n==null?{}:e(i(n)),s(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));Object.defineProperty(exports,`__commonJSMin`,{enumerable:!0,get:function(){return o}}),Object.defineProperty(exports,`__toESM`,{enumerable:!0,get:function(){return c}});

package/dist/cli.cjs

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-const e=require(`./cliCore-DVRzfEhV.cjs`),t=new e.CLI;t.run();
+const e=require(`./cliCore-CnIBp2pi.cjs`),t=new e.CLI;t.run();

package/dist/cli.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import{CLI as e}from"./cliCore-_ngOl27x.js";const t=new e;t.run();
+import{CLI as e}from"./cliCore-vfAofbYA.js";const t=new e;t.run();