@api-now/cli 1.14.6 → 1.16.0

package/README.md

@@ -11,9 +11,10 @@ The **API NOW! CLI** is a robust, cross-platform command-line tool designed to m
 - **Default Organization Management**: List organizations and pin a default workspace ID.
 - **Metadata and Media Uploads**: Create, list, and read blueprints, domains, and multimedia assets.
 - **Data Domain Management & Publishing**: Search, list, create, mutate via declarative JSON patch diffing, transition lifecycles (`draft`, `committed`, `published`), bump versions, run pre-publish validation, and publish domains directly to the Data Catalog.
-- **API Model Management**: Search, list, create, and read API Model files and schemas with immediate parent folder resolution.
+- **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.
 
 ---
@@ -334,6 +335,37 @@ cat ./api.json | apinow api oas --stdin --domain ./domain.json
 apinow api oas <file_id> -o ./openapi.json
 ```
 
+#### Generate TypeScript Client SDK (`api sdk`)
+
+Generate a type-safe TypeScript client SDK from an API model (live cloud model, local schema file, or STDIN). Supports generating raw source files directly into a project or a complete standalone npm package.
+
+```bash
+# Generate SDK files into the current working directory from a remote API model
+apinow api sdk --file <file_id> [--org <org_id>]
+
+# Generate SDK files into a designated output directory
+apinow api sdk <file_id> -o ./src/sdk
+
+# Generate SDK from local API model and Data Domain schema files
+apinow api sdk ./api.json --domain ./domain.json -o ./sdk
+
+# Generate SDK from schema piped via STDIN
+cat ./api.json | apinow api sdk --stdin --domain ./domain.json -o ./sdk
+
+# Generate a standalone npm package with package.json and tsconfig.json
+apinow api sdk <file_id> --standalone --package-name @my-org/my-api-sdk -o ./packages/my-api-sdk
+
+# Bake a base URL directly into the generated SDK client
+apinow api sdk <file_id> --base-url https://api.example.com/v1
+
+# Read the base URL automatically from an active deployment
+apinow api sdk <file_id> --deployment <deployment_id>
+```
+
+> [!TIP]
+> **Base URL Resolution & Interactive Mode**:
+> When generating an SDK for a remote API model without specifying `--base-url` or `--deployment`, the CLI in interactive TTY mode will prompt you to select an active deployment, enter a custom base URL, or skip baking the base URL so that consumers configure it at client initialization.
+
 ### 7. Schema Validation (`validate`)
 
 Validate local or remote Data Domain and API Model schemas against syntax, modeling rules, and naming conventions.
@@ -394,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