zuplo 6.67.32 → 6.68.0

package/docs/cli/source-migrate.mdx

@@ -0,0 +1,18 @@
+---
+title: "Zuplo CLI: Source Migrate"
+sidebar_label: source migrate
+---
+
+<CliCommand
+  command="source migrate"
+  description="Migration commands"
+>
+
+</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/source-upgrade.mdx

@@ -0,0 +1,41 @@
+---
+title: "Zuplo CLI: Source Upgrade"
+sidebar_label: source upgrade
+---
+
+<CliCommand
+  command="source upgrade"
+  description="Updates your project structure to the latest conventions"
+  options={[
+  {
+    "name": "dir",
+    "type": "string",
+    "description": "The directory containing your Zuplo API",
+    "default": ".",
+    "required": false,
+    "deprecated": false,
+    "hidden": true,
+    "normalize": true
+  }
+]}
+  examples={[
+  [
+    "$0 source upgrade",
+    "Upgrade your project structure to the latest conventions"
+  ],
+  [
+    "$0 source upgrade --dir ./my-zuplo-project",
+    "Specify the project directory path"
+  ]
+]}
+  usage="$0 source upgrade [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/test.mdx

@@ -0,0 +1,70 @@
+---
+title: "Zuplo CLI: Test"
+sidebar_label: test
+---
+
+<CliCommand
+  command="test"
+  description="Runs the tests under /tests against an endpoint"
+  options={[
+  {
+    "name": "endpoint",
+    "type": "string",
+    "description": "The URL of the Zuplo API to test against",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "filter",
+    "type": "string",
+    "description": "A filter to run a subset of tests (e.g., --filter 'test name' or --filter '/test-name-regex/')",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "dir",
+    "type": "string",
+    "description": "The directory containing your Zuplo API",
+    "default": ".",
+    "required": false,
+    "deprecated": false,
+    "hidden": true,
+    "normalize": true
+  }
+]}
+  examples={[
+  [
+    "$0 test --endpoint https://your-api-123abc.zuplo.app",
+    "Run all tests against your deployed API"
+  ],
+  [
+    "$0 test --endpoint https://your-api-123abc.zuplo.app --filter 'auth'",
+    "Run only tests matching 'auth' in their name"
+  ],
+  [
+    "$0 test --endpoint https://your-api-123abc.zuplo.app --filter '/api\\/v1/'",
+    "Run tests matching a regex pattern"
+  ],
+  [
+    "MY_VAR=example $0 test --endpoint https://your-api-123abc.zuplo.app",
+    "Run tests with environment variables"
+  ]
+]}
+  usage="$0 test --endpoint <url> [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)
+
+## Additional resources
+
+- [Testing your API](../articles/testing.mdx)
+- [Custom CI/CD](../articles/custom-ci-cd.mdx)

package/docs/cli/test.partial.mdx

@@ -0,0 +1,7 @@
+---
+additional-resources:
+  - name: Testing your API
+    href: ../articles/testing.mdx
+  - name: Custom CI/CD
+    href: ../articles/custom-ci-cd.mdx
+---

package/docs/cli/tunnel-create.mdx

@@ -0,0 +1,53 @@
+---
+title: "Zuplo CLI: Tunnel Create"
+sidebar_label: tunnel create
+---
+
+<CliCommand
+  command="tunnel create"
+  description="Creates a new tunnel in your account"
+  options={[
+  {
+    "name": "tunnel-name",
+    "type": "string",
+    "description": "The name of the tunnel to create",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 tunnel create --tunnel-name my-tunnel",
+    "Create a new tunnel"
+  ],
+  [
+    "$0 tunnel create --tunnel-name production-tunnel --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 tunnel create --tunnel-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)
+
+## Additional resources
+
+- [Secure Tunnels](../articles/secure-tunnel.mdx)
+- [Tunnel Setup & Configuration](../articles/tunnel-setup.mdx)
+- [Tunnel Troubleshooting](../articles/tunnel-troubleshooting.mdx)

package/docs/cli/tunnel-create.partial.mdx

@@ -0,0 +1,9 @@
+---
+additional-resources:
+  - name: Secure Tunnels
+    href: ../articles/secure-tunnel.mdx
+  - name: Tunnel Setup & Configuration
+    href: ../articles/tunnel-setup.mdx
+  - name: Tunnel Troubleshooting
+    href: ../articles/tunnel-troubleshooting.mdx
+---

package/docs/cli/tunnel-delete.mdx

@@ -0,0 +1,35 @@
+---
+title: "Zuplo CLI: Tunnel Delete"
+sidebar_label: tunnel delete
+---
+
+<CliCommand
+  command="tunnel delete"
+  description="Deletes a tunnel in your account"
+  examples={[
+  [
+    "$0 tunnel delete",
+    "Delete a tunnel (will prompt for tunnel selection)"
+  ],
+  [
+    "$0 tunnel delete --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 tunnel delete [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)
+
+## Additional resources
+
+- [Secure Tunnels](../articles/secure-tunnel.mdx)
+- [Tunnel Setup & Configuration](../articles/tunnel-setup.mdx)
+- [Tunnel Troubleshooting](../articles/tunnel-troubleshooting.mdx)

package/docs/cli/tunnel-delete.partial.mdx

@@ -0,0 +1,9 @@
+---
+additional-resources:
+  - name: Secure Tunnels
+    href: ../articles/secure-tunnel.mdx
+  - name: Tunnel Setup & Configuration
+    href: ../articles/tunnel-setup.mdx
+  - name: Tunnel Troubleshooting
+    href: ../articles/tunnel-troubleshooting.mdx
+---

package/docs/cli/tunnel-describe.mdx

@@ -0,0 +1,45 @@
+---
+title: "Zuplo CLI: Tunnel Describe"
+sidebar_label: tunnel describe
+---
+
+<CliCommand
+  command="tunnel describe"
+  description="Describes a tunnel in your account"
+  options={[
+  {
+    "name": "tunnel-id",
+    "type": "string",
+    "description": "The ID of the tunnel to describe",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 tunnel describe --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx",
+    "Get details about a tunnel"
+  ],
+  [
+    "$0 tunnel describe --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 tunnel describe --tunnel-id <id> [options]"
+>
+
+**Additional Resources**
+
+- [Secure Tunnels](../articles/secure-tunnel.mdx)
+- [Tunnel Setup & Configuration](../articles/tunnel-setup.mdx)
+- [Tunnel Troubleshooting](../articles/tunnel-troubleshooting.mdx)
+
+</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/tunnel-describe.partial.mdx

@@ -0,0 +1,5 @@
+**Additional Resources**
+
+- [Secure Tunnels](../articles/secure-tunnel.mdx)
+- [Tunnel Setup & Configuration](../articles/tunnel-setup.mdx)
+- [Tunnel Troubleshooting](../articles/tunnel-troubleshooting.mdx)

package/docs/cli/tunnel-list.mdx

@@ -0,0 +1,35 @@
+---
+title: "Zuplo CLI: Tunnel List"
+sidebar_label: tunnel list
+---
+
+<CliCommand
+  command="tunnel list"
+  description="Lists the tunnels in your account"
+  examples={[
+  [
+    "$0 tunnel list",
+    "List all tunnels"
+  ],
+  [
+    "$0 tunnel list --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 tunnel 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)
+
+## Additional resources
+
+- [Secure Tunnels](../articles/secure-tunnel.mdx)
+- [Tunnel Setup & Configuration](../articles/tunnel-setup.mdx)
+- [Tunnel Troubleshooting](../articles/tunnel-troubleshooting.mdx)

package/docs/cli/tunnel-list.partial.mdx

@@ -0,0 +1,9 @@
+---
+additional-resources:
+  - name: Secure Tunnels
+    href: ../articles/secure-tunnel.mdx
+  - name: Tunnel Setup & Configuration
+    href: ../articles/tunnel-setup.mdx
+  - name: Tunnel Troubleshooting
+    href: ../articles/tunnel-troubleshooting.mdx
+---

package/docs/cli/tunnel-rate-token.partial.mdx

@@ -0,0 +1,9 @@
+---
+additional-resources:
+  - name: Secure Tunnels
+    href: ../articles/secure-tunnel.mdx
+  - name: Tunnel Setup & Configuration
+    href: ../articles/tunnel-setup.mdx
+  - name: Tunnel Troubleshooting
+    href: ../articles/tunnel-troubleshooting.mdx
+---

package/docs/cli/tunnel-rotate-token.mdx

@@ -0,0 +1,39 @@
+---
+title: "Zuplo CLI: Tunnel Rotate Token"
+sidebar_label: tunnel rotate-token
+---
+
+<CliCommand
+  command="tunnel rotate-token"
+  description="Rotates the token for a tunnel in your account"
+  options={[
+  {
+    "name": "tunnel-id",
+    "type": "string",
+    "description": "The ID of the tunnel to rotate the token for",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 tunnel rotate-token --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx",
+    "Rotate the authentication token for a tunnel"
+  ],
+  [
+    "$0 tunnel rotate-token \\\n  --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx \\\n  --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 tunnel rotate-token --tunnel-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/tunnel-services-describe.mdx

@@ -0,0 +1,45 @@
+---
+title: "Zuplo CLI: Tunnel Services Describe"
+sidebar_label: tunnel services describe
+---
+
+<CliCommand
+  command="tunnel services describe"
+  description="Describes the services for this tunnel"
+  options={[
+  {
+    "name": "tunnel-id",
+    "type": "string",
+    "description": "The ID of the tunnel containing the services",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 tunnel services describe --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx",
+    "View the services configuration for a tunnel"
+  ],
+  [
+    "$0 tunnel services describe \\\n  --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx \\\n  --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 tunnel services describe --tunnel-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)
+
+## Additional resources
+
+- [Secure Tunnels](../articles/secure-tunnel.mdx)
+- [Tunnel Setup & Configuration](../articles/tunnel-setup.mdx)
+- [Tunnel Troubleshooting](../articles/tunnel-troubleshooting.mdx)

package/docs/cli/tunnel-services-describe.partial.mdx

@@ -0,0 +1,9 @@
+---
+additional-resources:
+  - name: Secure Tunnels
+    href: ../articles/secure-tunnel.mdx
+  - name: Tunnel Setup & Configuration
+    href: ../articles/tunnel-setup.mdx
+  - name: Tunnel Troubleshooting
+    href: ../articles/tunnel-troubleshooting.mdx
+---

package/docs/cli/tunnel-services-update.mdx

@@ -0,0 +1,48 @@
+---
+title: "Zuplo CLI: Tunnel Services Update"
+sidebar_label: tunnel services update
+---
+
+<CliCommand
+  command="tunnel services update"
+  description="Updates the services for this tunnel"
+  options={[
+  {
+    "name": "configuration-file",
+    "type": "string",
+    "description": "The path to the configuration file",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "normalize": true
+  },
+  {
+    "name": "tunnel-id",
+    "type": "string",
+    "description": "The ID of the tunnel containing the services",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 tunnel services update \\\n  --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx \\\n  --configuration-file ./services.json",
+    "Update the services configuration for a tunnel"
+  ],
+  [
+    "$0 tunnel services update \\\n  --tunnel-id tnl_TRMZwunq2PLNQDwhu6A04Bmx \\\n  --configuration-file ./config/tunnel-services.json \\\n  --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 tunnel services update --tunnel-id <id> --configuration-file <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/variable-create.mdx

@@ -0,0 +1,91 @@
+---
+title: "Zuplo CLI: Variable Create"
+sidebar_label: variable create
+---
+
+<CliCommand
+  command="variable create"
+  description="Creates a new variable for a branch"
+  options={[
+  {
+    "name": "name",
+    "type": "string",
+    "description": "The name of the variable to create",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "value",
+    "type": "string",
+    "description": "The value of the variable to create",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "branch",
+    "type": "string",
+    "description": "The branch where the variable should be set",
+    "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": "is-secret",
+    "type": "boolean",
+    "description": "Is the variable a secret",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 variable create \\\n  --name API_KEY \\\n  --value my-secret-key \\\n  --is-secret true \\\n  --branch main",
+    "Create a secret variable for the main branch"
+  ],
+  [
+    "$0 variable create \\\n  --name BASE_URL \\\n  --value https://api.example.com \\\n  --is-secret false \\\n  --branch production",
+    "Create a non-secret variable for the production branch"
+  ],
+  [
+    "$0 variable create \\\n  --name DB_HOST \\\n  --value localhost \\\n  --is-secret false \\\n  --branch dev \\\n  --account my-account \\\n  --project my-project",
+    "Explicitly specify the account and project"
+  ]
+]}
+  usage="$0 variable create \
+  --name <name> \
+  --value <value> \
+  --is-secret <boolean> \
+  --branch <branch> [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)
+
+## Additional resources
+
+- [Environment variables](../articles/environment-variables.mdx)

package/docs/cli/variable-create.partial.mdx

@@ -0,0 +1,5 @@
+---
+additional-resources:
+  - name: Environment variables
+    href: ../articles/environment-variables.mdx
+---

package/docs/cli/variable-update.mdx

@@ -0,0 +1,75 @@
+---
+title: "Zuplo CLI: Variable Update"
+sidebar_label: variable update
+---
+
+<CliCommand
+  command="variable update"
+  description="Updates an existing variable for a branch"
+  options={[
+  {
+    "name": "name",
+    "type": "string",
+    "description": "The name of the variable to update",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "value",
+    "type": "string",
+    "description": "The value of the variable to update",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "branch",
+    "type": "string",
+    "description": "The branch where the variable exists",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "project",
+    "type": "string",
+    "description": "The project name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  }
+]}
+  examples={[
+  [
+    "$0 variable update --name API_KEY --value new-secret-key --branch main",
+    "Update a variable on the main branch"
+  ],
+  [
+    "$0 variable update \\\n  --name BASE_URL \\\n  --value https://api.prod.example.com \\\n  --branch production \\\n  --account my-account \\\n  --project my-project",
+    "Explicitly specify the account and project"
+  ]
+]}
+  usage="$0 variable update --name <name> --value <value> --branch <branch> [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)
+
+## Additional resources
+
+- [Environment variables](../articles/environment-variables.mdx)

package/docs/cli/variable-update.partial.mdx

@@ -0,0 +1,5 @@
+---
+additional-resources:
+  - name: Environment variables
+    href: ../articles/environment-variables.mdx
+---