@stackone/cli 1.10.0 → 1.11.0

package/README.md

@@ -91,6 +91,45 @@ stackone push --api-key <your-api-key> --api-url <api-url> path/to/connector.s1.
 - **File validation**: Checks that the file exists and is a valid connector before attempting upload
 - **Batch upload**: Supports uploading multiple connectors from a directory
 
+### `drop`
+
+Drop (delete) a specific connector version from the StackOne API registry. This command can use either a configuration profile created with the `init` command or provide credentials directly via command-line options.
+
+```bash
+stackone drop <connector> --profile <profile-label>
+```
+
+or using direct credentials:
+
+```bash
+stackone drop <connector> --api-key <your-api-key>
+```
+
+or with custom API URL:
+
+```bash
+stackone drop <connector> --api-key <your-api-key> --api-url <api-url>
+```
+
+**Arguments:**
+
+- `<connector>` - The connector identifier in the format `provider_key@version` (e.g., `my-provider@1.0.0`)
+
+**Options:**
+
+- `-p, --profile <label>` - Configuration profile to use
+- `--api-key <api-key>` - API key to use for authentication (alternative to using a profile)
+- `--api-url <api-url>` - API URL to use (defaults to `https://api.stackone.com` if not specified)
+
+**Note:** You must provide either `--profile` or `--api-key`. If using `--api-key`, the `--api-url` option is optional and will default to the production API URL.
+
+**Features:**
+
+- **Flexible authentication**: Use either a saved profile or provide credentials directly
+- **Profile validation**: Ensures the specified profile exists before attempting deletion (when using `--profile`)
+- **Precise targeting**: Delete specific connector versions without affecting other versions
+- **Clear feedback**: Informative success and error messages with color-coded output
+
 ### `validate`
 
 Validate a StackOne connector file:
@@ -111,6 +150,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/cli.cjs

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-const e=require(`./cliCore-D3gL-zoM.cjs`),t=new e.CLI;t.run();
+const e=require(`./cliCore-CXBqMdiv.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-Bx4ZPYGH.js";const t=new e;t.run();
+import{CLI as e}from"./cliCore-DRnQtnk3.js";const t=new e;t.run();