@api-now/cli 1.15.0 → 1.17.0

package/README.md

@@ -14,6 +14,7 @@ The **API NOW! CLI** is a robust, cross-platform command-line tool designed to m
 - **API Model Management & Code Generation**: Search, list, create, and read API Model files, generate OpenAPI Specifications (OAS 3.1), and generate type-safe TypeScript client SDKs.
 - **Local & Remote Schema Validation**: Validate Data Domain and API Model schemas from local files, STDIN, or directly from remote organization files.
 - **Data Catalog Publishing**: Publish schemas and datasets to the global/private catalog with automatic semantic versioning support, deprecation, and unpublishing.
+- **Deployment Management**: List deployments filtered by API ID, inspect environments (production, staging, development), deployment statuses, model versions, and base URIs with robust permission and error handling.
 - **Developer Formatting Options**: Toggle outputs between human-friendly ASCII tables and machine-readable JSON.
 
 ---
@@ -425,6 +426,55 @@ apinow runtime users update --api <api_file_id_or_slug> --user-id <user_id> --pr
 apinow runtime users update --api api-123 --user-id user-123 --property role=admin tier=premium --org org-123
 ```
 
+### 10. Deployments (`deployment`)
+
+Manage API deployments in your organizations.
+
+#### List Deployments (`deployment list`)
+
+List all deployments for a specific API model file. Filter deployments by providing the API ID as a positional argument or with the `--api` option (alias: `--file`, `--id`).
+
+> [!NOTE]
+> Viewing deployments requires appropriate organization permissions. If your user account or token does not have permission to view deployments, the command returns an error (`CLI_ERR_FORBIDDEN`).
+
+```bash
+# List deployments for an API by ID (positional argument)
+apinow deployment list <api_file_id> [--org <org_id>]
+
+# List deployments using the --api flag
+apinow deployment list --api <api_file_id> [--org <org_id>]
+
+# List deployments using the --file flag alias
+apinow deployment list --file <api_file_id> [--org <org_id>]
+
+# Limit the number of deployment records returned
+apinow deployment list <api_file_id> --limit 10
+
+# Output deployment details in machine-readable JSON format
+apinow deployment list <api_file_id> --format json
+```
+
+#### Read Deployment Details (`deployment read` / `deployment get`)
+
+Read the detailed status and configuration of a specific deployment (including environments, base URI, portal URI, versions, and CORS settings).
+
+```bash
+# Read deployment details by ID (positional argument)
+apinow deployment read <deployment_id> [--org <org_id>]
+
+# Using the 'get' alias
+apinow deployment get <deployment_id> [--org <org_id>]
+
+# Read deployment using the --id flag
+apinow deployment read --id <deployment_id> [--org <org_id>]
+
+# Read deployment using the --deployment flag alias
+apinow deployment get --deployment <deployment_id> [--org <org_id>]
+
+# Output deployment details in machine-readable JSON format
+apinow deployment read <deployment_id> --format json
+```
+
 ---
 
 ## Development