From 7468bbdc96c992a085b90828594d962e2c0f193c Mon Sep 17 00:00:00 2001 From: MajidAbuRmila Date: Thu, 15 Jan 2026 14:05:42 +0200 Subject: [PATCH] Auto generated CLI documentation update --- .../ci-cd-development/container-image.mdx | 6 +- cli-reference/commands/apply.mdx | 2 +- cli-reference/commands/convert.mdx | 2 +- cli-reference/commands/cp.mdx | 2 +- cli-reference/commands/delete.mdx | 2 +- cli-reference/commands/helm.mdx | 2 +- cli-reference/commands/operator.mdx | 2 +- cli-reference/commands/port-forward.mdx | 2 +- cli-reference/commands/stack.mdx | 4 +- cli-reference/commands/workload.mdx | 6 +- cli-reference/installation.mdx | 30 +++---- mint.json | 83 +++++++++++++++---- 12 files changed, 96 insertions(+), 47 deletions(-) diff --git a/cli-reference/ci-cd-development/container-image.mdx b/cli-reference/ci-cd-development/container-image.mdx index 4756e3d..ee8e6c0 100644 --- a/cli-reference/ci-cd-development/container-image.mdx +++ b/cli-reference/ci-cd-development/container-image.mdx @@ -77,7 +77,7 @@ Never bake credentials into container images. Pass tokens at runtime via environ FROM debian:bookworm-slim AS cpln-downloader # Pin the CLI version for reproducible builds - ARG CPLN_BINARY_URL=https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz + ARG CPLN_BINARY_URL=https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz # Download and extract cpln binary RUN apt-get update && apt-get install -y --no-install-recommends curl ca-certificates && \ @@ -151,7 +151,7 @@ RUN npm install -g @controlplane/cli@${CPLN_CLI_VERSION} ``` ```dockerfile Binary -ARG CPLN_BINARY_URL=https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz +ARG CPLN_BINARY_URL=https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz ``` @@ -337,7 +337,7 @@ For more troubleshooting help, see the [Troubleshooting](/cli-reference/using-cl ``` ```dockerfile Binary - ARG CPLN_BINARY_URL=https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz + ARG CPLN_BINARY_URL=https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz RUN curl -fsSL "${CPLN_BINARY_URL}" -o /tmp/cpln.tgz && \ tar -xzf /tmp/cpln.tgz -C /usr/local/bin ``` diff --git a/cli-reference/commands/apply.mdx b/cli-reference/commands/apply.mdx index a97444a..dc569e5 100644 --- a/cli-reference/commands/apply.mdx +++ b/cli-reference/commands/apply.mdx @@ -4,7 +4,7 @@ title: apply Create or update a resource using an input file. -Refer to the [cpln apply guide](/cli-reference/guides/cpln-apply) for additional details. +Refer to the [cpln apply guide](/guides/cpln-apply) for additional details. diff --git a/cli-reference/commands/convert.mdx b/cli-reference/commands/convert.mdx index 5abd3d3..9b20858 100644 --- a/cli-reference/commands/convert.mdx +++ b/cli-reference/commands/convert.mdx @@ -4,7 +4,7 @@ title: convert Convert k8s files to cpln files -Refer to the [cpln convert guide](/cli-reference/guides/cpln-convert) for additional details. +Refer to the [cpln convert guide](/guides/cli/cpln-convert) for additional details. **Usage** diff --git a/cli-reference/commands/cp.mdx b/cli-reference/commands/cp.mdx index 1dd9d32..d23be10 100644 --- a/cli-reference/commands/cp.mdx +++ b/cli-reference/commands/cp.mdx @@ -4,7 +4,7 @@ title: cp Copy files and directories to and from workloads. -Refer to the [cpln cp guide](/cli-reference/guides/cpln-cp) for additional details. +Refer to the [cpln cp guide](/guides/cli/cpln-cp) for additional details. diff --git a/cli-reference/commands/delete.mdx b/cli-reference/commands/delete.mdx index a77fb0b..af68083 100644 --- a/cli-reference/commands/delete.mdx +++ b/cli-reference/commands/delete.mdx @@ -4,7 +4,7 @@ title: delete Delete resources from files -Refer to the [cpln delete guide](/cli-reference/guides/cpln-delete) for additional details. +Refer to the [cpln delete guide](/guides/cpln-delete) for additional details. **Usage** diff --git a/cli-reference/commands/helm.mdx b/cli-reference/commands/helm.mdx index c75d010..e474661 100644 --- a/cli-reference/commands/helm.mdx +++ b/cli-reference/commands/helm.mdx @@ -4,7 +4,7 @@ title: helm Manage helm releases on cpln -Refer to the [cpln helm guide](/cli-reference/guides/cpln-helm) for additional details. +Refer to the [cpln helm guide](/guides/cpln-helm) for additional details. diff --git a/cli-reference/commands/operator.mdx b/cli-reference/commands/operator.mdx index 96425e6..3567c37 100644 --- a/cli-reference/commands/operator.mdx +++ b/cli-reference/commands/operator.mdx @@ -4,7 +4,7 @@ title: operator A Kubernetes operator for Control Plane -Refer to the [cpln operator guide](/cli-reference/guides/cpln-operator) for additional details. +Refer to the [cpln operator guide](/guides/cli/cpln-operator) for additional details. diff --git a/cli-reference/commands/port-forward.mdx b/cli-reference/commands/port-forward.mdx index 8f4c7d3..8b6b41f 100644 --- a/cli-reference/commands/port-forward.mdx +++ b/cli-reference/commands/port-forward.mdx @@ -4,7 +4,7 @@ title: port-forward Establish secure local access to your workload. -Refer to the [cpln port-forward](/cli-reference/guides/cpln-port-forward) guide for additional details. +Refer to the [cpln port-forward](/guides/cli/cpln-port-forward) guide for additional details. diff --git a/cli-reference/commands/stack.mdx b/cli-reference/commands/stack.mdx index 8272c6c..807199c 100644 --- a/cli-reference/commands/stack.mdx +++ b/cli-reference/commands/stack.mdx @@ -4,7 +4,7 @@ title: stack manage docker-compose files -Refer to the [Compose Deploy guide](/cli-reference/guides/compose-deploy) for additional details. +Refer to the [Compose Deploy guide](/guides/compose-deploy) for additional details. @@ -36,7 +36,7 @@ Options: deploy from a docker-compose file -Refer to the [compose deploy guide](/cli-reference/guides/compose-deploy) for more details. +Refer to the [compose deploy guide](/guides/compose-deploy) for more details. **Usage** diff --git a/cli-reference/commands/workload.mdx b/cli-reference/commands/workload.mdx index 5325dda..7a6b9d9 100644 --- a/cli-reference/commands/workload.mdx +++ b/cli-reference/commands/workload.mdx @@ -234,7 +234,7 @@ Connect to a replica of the workload If multiple replicas are running, use the --replica flag to specify the replica. Use the subcommand [get-replicas](#workload-get-replicas) to view the current list of replicas. -Refer to the [cpln workload connect guide](/cli-reference/guides/workload-connect) for additional details. +Refer to the [cpln workload connect guide](/guides/cli/workload/connect) for additional details. **Usage** @@ -967,7 +967,7 @@ The event log for the referenced workload will be shown. Exec a command on a replica of the workload. -Refer to the [cpln workload exec guide](/cli-reference/guides/workload-exec) for additional details. +Refer to the [cpln workload exec guide](/guides/cli/workload/exec) for additional details. @@ -1930,7 +1930,7 @@ cpln workload replica stop demo-workload --replica-name demo-workload-0 --locati Run a command with a workload instance. -Refer to the [cpln workload run guide](/cli-reference/guides/workload-run) for additional details. +Refer to the [cpln workload run guide](/guides/cli/workload/run) for additional details. diff --git a/cli-reference/installation.mdx b/cli-reference/installation.mdx index 6db1d02..096ecc9 100644 --- a/cli-reference/installation.mdx +++ b/cli-reference/installation.mdx @@ -57,16 +57,16 @@ Download and install the binary package for your operating system. - + Download for Apple Silicon - + Download for Intel Macs - + Download for Linux (x64) or for Windows (WSL2) - + Download for Windows 10/11 @@ -76,13 +76,13 @@ Download and install the binary package for your operating system. ```bash - curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-macos-arm64.dmg + curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-macos-arm64.dmg ``` ```bash - curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-macos-x64.dmg + curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-macos-x64.dmg ``` @@ -90,11 +90,11 @@ Download and install the binary package for your operating system. ```bash curl - curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz + curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz ``` ```bash wget - wget https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz + wget https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz ``` @@ -102,18 +102,18 @@ Download and install the binary package for your operating system. ```powershell - Invoke-WebRequest -Uri "https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-win.zip" -OutFile "cpln-win.zip" + Invoke-WebRequest -Uri "https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-win.zip" -OutFile "cpln-win.zip" ``` ```bash curl - curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz + curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz ``` ```bash wget - wget https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz + wget https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz ``` @@ -212,10 +212,10 @@ Download and install the binary package for your operating system. | OS | File | SHA256 | |---------------|----------------------|----------------------| -| macOS-arm64 | cpln-macos-arm64.dmg | 476d2e05792dd85031dfb87aeed52d722d6455b65a075feba3cfe14f19b644a8 | -| macOS-x64 | cpln-macos-x64.dmg | 5dedd3212730164a46979b174bee64dc935e490b90cb06315c96f703f411ab3a | -| Linux | cpln-linux.tgz | a106329e4c8767968f5afc8182b1bceb0dcb15bb8d9d366541960a74d5652887 | -| Windows 10/11 | cpln-win.zip | dfb648a27ee99a617a6ca3c8cf6d3bfd85456acdd9d2393a8497ee057fbd4ba8 | +| macOS-arm64 | cpln-macos-arm64.dmg | | +| macOS-x64 | cpln-macos-x64.dmg | | +| Linux | cpln-linux.tgz | 0152781e4f4a974edb3eb4ee654d84ed3a4d6ba674b2e21dbb6db4f36a3f0bdb | +| Windows 10/11 | cpln-win.zip | 2bf0567f1ff689164d466e29fb5a65c7cadd58be24ecb4a28ea1ddba96efc4ec | diff --git a/mint.json b/mint.json index 5330270..0d2371e 100644 --- a/mint.json +++ b/mint.json @@ -46,7 +46,11 @@ "navigation": [ { "group": " ", - "pages": ["whatis", "releases", "compliance"] + "pages": [ + "whatis", + "releases", + "compliance" + ] }, { "group": "Quickstart", @@ -88,7 +92,11 @@ }, { "group": "Observability", - "pages": ["guides/export-metrics", "guides/centralized-metrics-management", "guides/default-metrics"] + "pages": [ + "guides/export-metrics", + "guides/centralized-metrics-management", + "guides/default-metrics" + ] }, { "group": "Create Resources", @@ -107,7 +115,10 @@ }, { "group": "GitOps", - "pages": ["guides/gitops", "guides/environment-promotion"] + "pages": [ + "guides/gitops", + "guides/environment-promotion" + ] }, { "group": "Native Networking", @@ -115,11 +126,15 @@ "guides/native-networking/native-networking-setup", { "group": "GCP Private Service Connect", - "pages": ["guides/native-networking/private-service-connect/cloud-sql"] + "pages": [ + "guides/native-networking/private-service-connect/cloud-sql" + ] }, { "group": "AWS PrivateLink", - "pages": ["guides/native-networking/aws-privatelink/privatelink-rds-terraform"] + "pages": [ + "guides/native-networking/aws-privatelink/privatelink-rds-terraform" + ] } ] } @@ -172,7 +187,12 @@ "byok/overview", { "group": "Custom Settings", - "pages": ["byok/settings/actuator", "byok/settings/agent", "byok/settings/workload", "byok/settings/volumeset"] + "pages": [ + "byok/settings/actuator", + "byok/settings/agent", + "byok/settings/workload", + "byok/settings/volumeset" + ] } ] }, @@ -182,22 +202,34 @@ "mcp/overview", { "group": "Tool Setup", - "pages": ["mcp/claude", "mcp/codex", "mcp/cursor", "mcp/vscode", "mcp/antigravity"] + "pages": [ + "mcp/claude", + "mcp/codex", + "mcp/cursor", + "mcp/vscode", + "mcp/antigravity" + ] }, "mcp/examples" ] }, { "group": "Terraform Provider", - "pages": ["terraform/installation"] + "pages": [ + "terraform/installation" + ] }, { "group": "Pulumi Provider", - "pages": ["pulumi/installation"] + "pages": [ + "pulumi/installation" + ] }, { "group": "Kubernetes Operator", - "pages": ["k8s-operator/overview"] + "pages": [ + "k8s-operator/overview" + ] }, { "group": "Reference", @@ -246,7 +278,9 @@ }, { "group": "API Reference", - "pages": ["api-reference/api"] + "pages": [ + "api-reference/api" + ] }, { "group": "Core API", @@ -532,7 +566,9 @@ }, { "group": "Producer", - "pages": ["api-reference/audit/producer/create-a-new-audit-event"] + "pages": [ + "api-reference/audit/producer/create-a-new-audit-event" + ] } ] }, @@ -562,7 +598,10 @@ }, { "group": "CI/CD & Development", - "pages": ["cli-reference/ci-cd-development/ci-cd", "cli-reference/ci-cd-development/container-image"] + "pages": [ + "cli-reference/ci-cd-development/ci-cd", + "cli-reference/ci-cd-development/container-image" + ] } ] }, @@ -591,11 +630,18 @@ }, { "group": "Images", - "pages": ["cli-reference/guides/push-image", "cli-reference/guides/pull-image", "cli-reference/guides/copy-image"] + "pages": [ + "cli-reference/guides/push-image", + "cli-reference/guides/pull-image", + "cli-reference/guides/copy-image" + ] }, { "group": "Setup", - "pages": ["cli-reference/guides/browser-less-cli-login", "cli-reference/guides/cpln-operator"] + "pages": [ + "cli-reference/guides/browser-less-cli-login", + "cli-reference/guides/cpln-operator" + ] } ] }, @@ -726,11 +772,14 @@ "url": "api-reference" } ], - "openapi": ["https://api.cpln.io/openapi.json", "https://audit.cpln.io/openapi.json"], + "openapi": [ + "https://api.cpln.io/openapi.json", + "https://audit.cpln.io/openapi.json" + ], "api": { "baseUrl": "https://api.cpln.io", "auth": { "method": "bearer" } } -} +} \ No newline at end of file