Skip to content

Auto generated CLI documentation update #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MajidAbuRmila wants to merge 1 commit into from
Closed

Auto generated CLI documentation update #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cli-reference/ci-cd-development/container-image.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 && \
Expand Down Expand Up @@ -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
```
</CodeGroup>

Expand Down Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/apply.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/convert.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/cp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/helm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/operator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/port-forward.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
4 changes: 2 additions & 2 deletions cli-reference/commands/stack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down Expand Up @@ -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**

Expand Down
6 changes: 3 additions & 3 deletions cli-reference/commands/workload.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down Expand Up @@ -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.



Expand Down Expand Up @@ -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.

<Note>

Expand Down
30 changes: 15 additions & 15 deletions cli-reference/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,16 @@ Download and install the binary package for your operating system.
<Tabs>
<Tab title="Browser">
<CardGroup cols={2}>
<Card title="macOS (ARM64)" icon="apple" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-macos-arm64.dmg">
<Card title="macOS (ARM64)" icon="apple" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-macos-arm64.dmg">
Download for Apple Silicon
</Card>
<Card title="macOS (x64)" icon="apple" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-macos-x64.dmg">
<Card title="macOS (x64)" icon="apple" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-macos-x64.dmg">
Download for Intel Macs
</Card>
<Card title="Linux / WSL2" icon="linux" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-linux.tgz">
<Card title="Linux / WSL2" icon="linux" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-linux.tgz">
Download for Linux (x64) or for Windows (WSL2)
</Card>
<Card title="Windows" icon="microsoft" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264554840-29dcedda/cpln-win.zip">
<Card title="Windows" icon="microsoft" href="https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2264796148-c363db47/cpln-win.zip">
Download for Windows 10/11
</Card>
</CardGroup>
Expand All @@ -76,44 +76,44 @@ Download and install the binary package for your operating system.
<Tabs>
<Tab title="macOS (ARM64)" icon="apple">
```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
```
</Tab>

<Tab title="macOS (x64)" icon="apple">
```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
```
</Tab>

<Tab title="Linux" icon="linux">

<CodeGroup>
```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
```
</CodeGroup>

</Tab>

<Tab title="Windows (PowerShell)" icon="microsoft">
```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"
```
</Tab>

<Tab title="Windows (WSL2)" icon="linux">
<CodeGroup>
```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
```
</CodeGroup>

Expand Down Expand Up @@ -212,10 +212,10 @@ Download and install the binary package for your operating system.
<Accordion title="Verify checksums">
| 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 |
</Accordion>

<Info>
Expand Down
Loading