zuplo 6.67.32 → 6.68.0

package/docs/cli/mtls-certificate-disable.mdx

@@ -0,0 +1,55 @@
+---
+title: "Zuplo CLI: Mtls Certificate Disable"
+sidebar_label: mtls-certificate disable
+---
+
+<CliCommand
+  command="mtls-certificate disable"
+  description="Disables an mTLS certificate for all environment types"
+  options={[
+  {
+    "name": "cert-id",
+    "type": "string",
+    "description": "The ID of the certificate to disable",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "project",
+    "type": "string",
+    "description": "The project name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 mtls-certificate disable --cert-id cert_abc123",
+    "Disable certificate for all environment types"
+  ],
+  [
+    "$0 mtls-certificate disable \\\n  --cert-id cert_abc123 \\\n  --account my-account \\\n  --project my-project",
+    "Explicitly specify the account and project"
+  ]
+]}
+  usage="$0 mtls-certificates disable --cert-id <id> [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/mtls-certificate-list.mdx

@@ -0,0 +1,47 @@
+---
+title: "Zuplo CLI: Mtls Certificate List"
+sidebar_label: mtls-certificate list
+---
+
+<CliCommand
+  command="mtls-certificate list"
+  description="Lists all mTLS certificates for a project"
+  options={[
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "project",
+    "type": "string",
+    "description": "The project name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 mtls-certificates list",
+    "List all mTLS certificates for your project"
+  ],
+  [
+    "$0 mtls-certificates list --account my-account --project my-project",
+    "Explicitly specify the account and project"
+  ]
+]}
+  usage="$0 mtls-certificates list [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/mtls-certificate-update.mdx

@@ -0,0 +1,72 @@
+---
+title: "Zuplo CLI: Mtls Certificate Update"
+sidebar_label: mtls-certificate update
+---
+
+<CliCommand
+  command="mtls-certificate update"
+  description="Updates the environment settings for an mTLS certificate"
+  options={[
+  {
+    "name": "cert-id",
+    "type": "string",
+    "description": "The ID of the certificate to update",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "project",
+    "type": "string",
+    "description": "The project name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "environment-type",
+    "type": "array",
+    "description": "Environment types where the certificate should be enabled (can be repeated: --environment-type development --environment-type production)",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "choices": [
+      "development",
+      "preview",
+      "production"
+    ]
+  }
+]}
+  examples={[
+  [
+    "$0 mtls-certificate update --cert-id cert_abc123 --environment-type production",
+    "Update certificate to be enabled only for production environment type"
+  ],
+  [
+    "$0 mtls-certificate update \\\n  --cert-id cert_abc123 \\\n  --environment-type development \\\n  --environment-type preview \\\n  --environment-type production",
+    "Update certificate to be enabled for all environment types"
+  ],
+  [
+    "$0 mtls-certificate update \\\n  --cert-id cert_abc123 \\\n  --environment-type development \\\n  --account my-account \\\n  --project my-project",
+    "Explicitly specify the account and project"
+  ]
+]}
+  usage="$0 mtls-certificates update --cert-id <id> --environment <env> [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/openapi-convert.mdx

@@ -0,0 +1,111 @@
+---
+title: "Zuplo CLI: OpenAPI Convert"
+sidebar_label: openapi convert
+---
+
+<CliCommand
+  command="openapi convert"
+  description="Convert OpenAPI files between JSON and YAML formats"
+  options={[
+  {
+    "name": "input",
+    "type": "string",
+    "description": "The input OpenAPI file (JSON or YAML)",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "i"
+    ],
+    "normalize": true
+  },
+  {
+    "name": "format",
+    "type": "string",
+    "description": "Output format",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "f"
+    ],
+    "choices": [
+      "json",
+      "yaml"
+    ]
+  },
+  {
+    "name": "output",
+    "type": "string",
+    "description": "Output file path (if not specified, generates based on input)",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "o"
+    ],
+    "normalize": true
+  },
+  {
+    "name": "json",
+    "type": "boolean",
+    "description": "Convert to JSON format",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "conflicts": [
+      "yaml",
+      "format"
+    ]
+  },
+  {
+    "name": "yaml",
+    "type": "boolean",
+    "description": "Convert to YAML format",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "conflicts": [
+      "json",
+      "format"
+    ]
+  },
+  {
+    "name": "watch",
+    "type": "boolean",
+    "description": "Watch input file for changes and automatically re-convert",
+    "default": false,
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 oas convert --input openapi.yaml --json",
+    "Convert a YAML OpenAPI file to JSON format"
+  ],
+  [
+    "$0 oas convert -i openapi.json --yaml -o api-spec.yaml",
+    "Convert a JSON OpenAPI file to YAML with custom output path"
+  ],
+  [
+    "$0 oas convert --input api.yaml --format json",
+    "Convert using --format flag instead of --json/--yaml"
+  ],
+  [
+    "$0 oas convert --input openapi.yaml --json --watch",
+    "Watch the input file for changes and automatically re-convert"
+  ]
+]}
+  usage="$0 oas convert --input <file> (--json|--yaml|--format <format>) [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/openapi-merge.mdx

@@ -0,0 +1,138 @@
+---
+title: "Zuplo CLI: OpenAPI Merge"
+sidebar_label: openapi merge
+---
+
+<CliCommand
+  command="openapi merge"
+  description="Merge an OpenAPI file into your Zuplo project"
+  options={[
+  {
+    "name": "source",
+    "type": "string",
+    "description": "The OpenAPI file to merge (file path or URL)",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "s"
+    ]
+  },
+  {
+    "name": "destination",
+    "type": "string",
+    "description": "The destination file name (must end with .oas.json)",
+    "default": "./config/routes.oas.json",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "d"
+    ]
+  },
+  {
+    "name": "merge-mode",
+    "type": "string",
+    "description": "The merge mode to use when merging the OpenAPI file",
+    "default": "path-method",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "m"
+    ],
+    "choices": [
+      "path-method",
+      "operation-id"
+    ]
+  },
+  {
+    "name": "prepend-path",
+    "type": "string",
+    "description": "Directly provide a path to prepend to all paths (e.g., '/v1')",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "server-paths",
+    "type": "boolean",
+    "description": "Prepend the pathname from the first server URL to all paths",
+    "default": true,
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "watch",
+    "type": "boolean",
+    "description": "Watch source file for changes and automatically re-merge",
+    "default": false,
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 oas merge --source openapi.yaml --destination ./config/routes.oas.json",
+    "Merge an OpenAPI file into your Zuplo project"
+  ],
+  [
+    "$0 oas merge -s https://api.example.com/openapi.json -d ./config/api.oas.json",
+    "Merge an OpenAPI file from a URL"
+  ],
+  [
+    "$0 oas merge \\\n  --source openapi.yaml \\\n  --destination ./config/routes.oas.json \\\n  --merge-mode operation-id",
+    "Merge using operation-id instead of path-method matching"
+  ],
+  [
+    "$0 oas merge \\\n  --source openapi.yaml \\\n  --destination ./config/routes.oas.json \\\n  --prepend-path /v1",
+    "Merge and prepend '/v1' to all paths"
+  ],
+  [
+    "$0 oas merge \\\n  --source openapi.yaml \\\n  --destination ./config/routes.oas.json \\\n  --watch",
+    "Watch the source file for changes and automatically re-merge"
+  ]
+]}
+  usage="$0 oas merge --source <file|url> --destination <file> [options]"
+>
+
+## Common use cases
+
+### Importing an existing OpenAPI file
+
+The command supports importing both JSON and YAML formats. The format is
+inferred from the file extension.
+
+```bash
+zuplo openapi merge --source /path/to/openapi.json
+zuplo openapi merge --source /path/to/openapi.yaml
+```
+
+When no `--destination` option is provided, the OpenAPI file is automatically
+merged into `routes.oas.json`.
+
+To import a remote file, use the `--source` option with a URL. The command
+downloads the file to a temporary directory and imports it.
+
+```bash
+zuplo openapi merge --source https://example.com/path/to/openapi.json
+```
+
+To rename the destination file, use the `--destination` option.
+
+```bash
+zuplo openapi merge \
+  --source https://example.com/path/to/openapi.json \
+  --destination new-name
+```
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/openapi-merge.partial.mdx

@@ -0,0 +1,29 @@
+## Common use cases
+
+### Importing an existing OpenAPI file
+
+The command supports importing both JSON and YAML formats. The format is
+inferred from the file extension.
+
+```bash
+zuplo openapi merge --source /path/to/openapi.json
+zuplo openapi merge --source /path/to/openapi.yaml
+```
+
+When no `--destination` option is provided, the OpenAPI file is automatically
+merged into `routes.oas.json`.
+
+To import a remote file, use the `--source` option with a URL. The command
+downloads the file to a temporary directory and imports it.
+
+```bash
+zuplo openapi merge --source https://example.com/path/to/openapi.json
+```
+
+To rename the destination file, use the `--destination` option.
+
+```bash
+zuplo openapi merge \
+  --source https://example.com/path/to/openapi.json \
+  --destination new-name
+```

package/docs/cli/openapi-overlay.mdx

@@ -0,0 +1,123 @@
+---
+title: "Zuplo CLI: OpenAPI Overlay"
+sidebar_label: openapi overlay
+---
+
+<CliCommand
+  command="openapi overlay"
+  description="Apply an OpenAPI Overlay to an OpenAPI document"
+  options={[
+  {
+    "name": "input",
+    "type": "string",
+    "description": "The input OpenAPI file",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "i"
+    ],
+    "normalize": true
+  },
+  {
+    "name": "overlay",
+    "type": "string",
+    "description": "The overlay file",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "l"
+    ],
+    "normalize": true
+  },
+  {
+    "name": "output",
+    "type": "string",
+    "description": "The output OpenAPI file path",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "o"
+    ],
+    "normalize": true
+  },
+  {
+    "name": "format",
+    "type": "string",
+    "description": "Output format",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "f"
+    ],
+    "choices": [
+      "json",
+      "yaml"
+    ]
+  },
+  {
+    "name": "json",
+    "type": "boolean",
+    "description": "Output in JSON format",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "conflicts": [
+      "yaml",
+      "format"
+    ]
+  },
+  {
+    "name": "yaml",
+    "type": "boolean",
+    "description": "Output in YAML format",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "conflicts": [
+      "json",
+      "format"
+    ]
+  },
+  {
+    "name": "watch",
+    "type": "boolean",
+    "description": "Watch input and overlay files for changes and automatically re-apply",
+    "default": false,
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 oas overlay --input openapi.json --overlay changes.json --output result.json",
+    "Apply an overlay to an OpenAPI document"
+  ],
+  [
+    "$0 oas overlay -i api.yaml -v overlay.yaml -o result.yaml --yaml",
+    "Apply overlay and output in YAML format"
+  ],
+  [
+    "$0 oas overlay \\\n  --input openapi.json \\\n  --overlay overlay.json \\\n  --output result.yaml \\\n  --format yaml",
+    "Apply overlay and convert format in one step"
+  ],
+  [
+    "$0 oas overlay \\\n  --input openapi.json \\\n  --overlay changes.json \\\n  --output result.json \\\n  --watch",
+    "Watch input and overlay files for changes and automatically re-apply"
+  ]
+]}
+  usage="$0 oas overlay --input <file> --overlay <file> --output <file> [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/overview.mdx

@@ -0,0 +1,78 @@
+---
+title: Zuplo CLI
+sidebar_label: Overview
+---
+
+The Zuplo CLI provides convenient tooling for common tasks that you might want
+to automate. You can use it to deploy Zuplo projects through CI/CD, create and
+update environment variables, manage your tunnels, and more! It's powered by the
+[Zuplo Developer API](https://dev.zuplo.com/docs), which you can also call
+directly, if you want to create your own tooling.
+
+## Installing
+
+The Zuplo CLI is built using Node.js. It requires a minimum version of Node.js
+20.0.0 (Node.js 22 is recommended).
+
+1. Install Node.js 20.0.0 or later. You can download it from
+   [nodejs.org](https://nodejs.org/en/download/).
+1. Install the Zuplo CLI globally by running the following command:
+
+   ```bash
+   npm install -g zuplo
+   ```
+
+1. After installing the CLI, you can use the `zuplo` command to interact with
+   Zuplo.
+
+### Verifying Installation
+
+Run the following command to confirm the CLI is installed correctly:
+
+```bash
+zuplo --version
+```
+
+### Updating
+
+To update the Zuplo CLI to the latest version, run the same install command:
+
+```bash
+npm install -g zuplo@latest
+```
+
+## Quick Start
+
+After installing the CLI, log in to your Zuplo account and deploy a project:
+
+```bash
+zuplo login
+zuplo deploy --project my-project
+```
+
+For details on authentication options, including API key usage for CI/CD
+pipelines, see [Authentication](./authentication.mdx).
+
+## Commands
+
+| Command | Description |
+| --- | --- |
+| [`deploy`](./deploy.mdx) | Deploy a Zuplo project to an environment |
+| [`dev`](./dev.mdx) | Start a local development server |
+| [`test`](./test.mdx) | Run API tests against a deployment |
+| [`init`](./init.mdx) | Initialize a new Zuplo project in the current directory |
+| [`link`](./link.mdx) | Link a local directory to an existing Zuplo project |
+| [`list`](./list.mdx) | List available Zuplo projects |
+| [`delete`](./delete.mdx) | Delete a Zuplo project or environment |
+| [`login`](./authentication.mdx) | Authenticate with your Zuplo account via OAuth |
+| [`variable-create`](./variable-create.mdx) | Create an environment variable |
+| [`variable-update`](./variable-update.mdx) | Update an environment variable |
+| [`tunnel-create`](./tunnel-create.mdx) | Create a new tunnel |
+| [`tunnel-list`](./tunnel-list.mdx) | List tunnels for a project |
+| [`tunnel-delete`](./tunnel-delete.mdx) | Delete a tunnel |
+
+For a complete list of commands and flags, run `zuplo --help` or see
+[Global Options](./global-options.mdx).
+
+To scaffold a new project without installing the CLI, see
+[create-zuplo-api](./create-zuplo-api.mdx).

package/docs/cli/project-create.mdx

@@ -0,0 +1,43 @@
+---
+title: "Zuplo CLI: Project Create"
+sidebar_label: project create
+---
+
+<CliCommand
+  command="project create"
+  description="Creates a new project in your account"
+  options={[
+  {
+    "name": "name",
+    "type": "string",
+    "description": "The name of the project to create",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 project create --name my-api-project",
+    "Create a new project with the specified name"
+  ],
+  [
+    "$0 project create",
+    "Create a new project (will prompt for name)"
+  ],
+  [
+    "$0 project create --name my-project --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 project create [--name <name>] [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)