@stackone/cli 1.15.0 → 1.15.2

package/README.md

@@ -91,6 +91,88 @@ 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
 
+### `pull`
+
+Pull a connector from the StackOne API registry to your local filesystem. This command fetches a connector from the registry and saves it locally, with interactive conflict resolution when the connector already exists.
+
+```bash
+stackone pull --connector my-provider@1.0.0 --profile <profile-label>
+```
+
+or using direct credentials:
+
+```bash
+stackone pull --connector my-provider@1.0.0 --api-key <your-api-key>
+```
+
+or with custom API URL:
+
+```bash
+stackone pull --connector my-provider@1.0.0 --api-key <your-api-key> --api-url <api-url>
+```
+
+or pulling the latest version:
+
+```bash
+stackone pull --connector my-provider --profile <profile-label>
+```
+
+**Options:**
+
+- `--connector <connector>` - Connector identifier in format `provider_key@version` (e.g., `my-provider@1.0.0`), `provider_key` to pull the latest version, or with version wildcards (e.g., `my-provider@1.x.x`, `my-provider@2.1.x` or `my-provider@latest`)
+- `-o, --output-path <output-path>` - Directory path to save the connector to (defaults to `./connectors/<provider_key>/`)
+- `-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.
+
+**Usage Examples:**
+
+1. **Pull specific version with profile:**
+
+   ```bash
+   stackone pull --connector my-provider@1.0.0 --profile production
+   ```
+
+2. **Pull latest version with API key:**
+
+   ```bash
+   stackone pull --connector my-provider --api-key your-api-key
+   ```
+
+3. **Pull to custom directory:**
+
+   ```bash
+   stackone pull --connector my-provider@1.0.0 --profile production --output-path ./my-connectors
+   ```
+
+4. **Pull with custom API URL:**
+
+   ```bash
+   stackone pull --connector my-provider@1.0.0 --api-key your-api-key --api-url https://staging.api.stackone.com
+   ```
+
+**Conflict Resolution:**
+
+When pulling a connector that already exists locally, the command will:
+
+1. Display a diff showing the differences between local and registry versions
+2. Prompt you to choose how to resolve the conflict:
+   - **Override with registry version** - Replace local file with the registry version
+   - **Keep local version** - Discard changes and keep the local file
+   - **Interactive resolution** - Manually resolve conflicts line by line
+
+**Features:**
+
+- **Flexible authentication**: Use either a saved profile or provide credentials directly
+- **Version flexibility**: Pull specific versions, use wildcards (e.g., `1.x.x`, `2.1.x`, `latest`), or omit version for latest
+- **Interactive conflict resolution**: Smart diff-based conflict resolution when local changes exist
+- **Profile validation**: Ensures the specified profile exists before fetching (when using `--profile`)
+- **Automatic file organization**: Saves connectors in organized directory structure (`./connectors/<provider_key>/`)
+- **Local validation**: Validates local connector before conflict resolution
+- **Clear feedback**: Informative success and error messages with color-coded output
+
 ### `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.
@@ -138,6 +220,12 @@ Get (download) a connector from the StackOne registry. This command can use eith
 stackone get --connector my-provider@1.0.0 --profile <profile-label>
 ```
 
+or get the latest version:
+
+```bash
+stackone get --connector my-provider --profile <profile-label>
+```
+
 or using direct credentials:
 
 ```bash
@@ -152,7 +240,7 @@ stackone get --account-id acc_123 --profile <profile-label>
 
 **Options:**
 
-- `--connector <connector>` - Connector identifier in format `provider_key@version` (e.g., `my-provider@1.0.0`)
+- `--connector <connector>` - Connector identifier in format `provider_key@version` (e.g., `my-provider@1.0.0`), `provider_key` to get the latest version, or with version wildcards (e.g., `my-provider@1.x.x`, `my-provider@2.1.x` or `my-provider@latest`)
 - `--account-id <account-id>` - Account ID to fetch the connector from
 - `-f, --format <format>` - Output format: `yaml` or `json` (default: `yaml`)
 - `-o, --output-file <output-file>` - File path to write the connector to (if not specified, outputs to stdout)
@@ -173,10 +261,10 @@ stackone get --account-id acc_123 --profile <profile-label>
    stackone get --connector my-provider@1.0.0 --profile production
    ```
 
-2. **Get connector from registry with API key:**
+2. **Get latest version from registry with API key:**
 
    ```bash
-   stackone get --connector my-provider@1.0.0 --api-key your-api-key
+   stackone get --connector my-provider --api-key your-api-key
    ```
 
 3. **Get connector from account:**
@@ -206,6 +294,7 @@ stackone get --account-id acc_123 --profile <profile-label>
 **Features:**
 
 - **Flexible authentication**: Use either a saved profile or provide credentials directly
+- **Version flexibility**: Get specific versions, use wildcards (e.g., `1.x.x`, `2.1.x`, `latest`), or omit version for latest
 - **Multiple sources**: Fetch connectors from registry by identifier or from specific accounts
 - **Format conversion**: Output in YAML (default) or JSON format
 - **File output**: Save to file or output to stdout for piping
@@ -248,7 +337,7 @@ stackone run --account-id <account-id> --api-key <your-api-key>
 
 **Options:**
 
-- `--connector <connector>` - Path to the connector file to run, inline connector YAML string, or connector identifier in format `provider_key@version` to fetch from registry (optional when using `--account-id`, the connector will be fetched from account API)
+- `--connector <connector>` - Path to the connector file to run, inline connector YAML string, or connector identifier in format `provider_key@version`, `provider_key` for latest, or with version wildcards (e.g., `my-provider@1.x.x`, `my-provider@2.1.x` or `my-provider@latest`) to fetch from registry (optional when using `--account-id`, the connector will be fetched from account API)
 - `--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)
@@ -390,7 +479,7 @@ All fields are optional and default to empty objects `{}`.
 
 - Either `--account` or `--account-id` must be provided
 - When using `--account-id`, either `--profile` or `--api-key` is required
-- When using connector identifier format (`provider_key@version`), either `--profile` or `--api-key` is required
+- When using connector identifier format (`provider_key@version` or `provider_key`), either `--profile` or `--api-key` is required
 - You must provide either `--profile` or `--api-key`, not both
 - When using `--action`, the `--connector` option is required
 - A connector can be provided via:
@@ -400,7 +489,7 @@ All fields are optional and default to empty objects `{}`.
 
 **Features:**
 
-- **Flexible connector loading**: Load from file path, provide inline YAML, fetch from registry using `provider_key@version` identifier, or auto-fetch from API using account ID
+- **Flexible connector loading**: Load from file path, provide inline YAML, fetch from registry using `provider_key@version`, `provider_key` for latest, or version wildcards (e.g., `1.x.x` or `latest`), or auto-fetch from API using account ID
 - **Flexible authentication**: Use either a saved profile or provide credentials directly via command-line options
 - **Dynamic action injection**: Add custom actions to existing connectors on-the-fly
 - **Multiple authentication methods**: Use API-fetched accounts or local account data

package/dist/cli.cjs

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

package/dist/cli.mjs

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import{t as e}from"./cliCore-BDikKAKf.mjs";new e().run();export{};
+import{t as e}from"./cliCore-BgcnPiab.mjs";new e().run();export{};