Skip to content

docs: add version markers to CLI and SDK documentation #149

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

Merged
Leechael merged 1 commit into from
Mar 4, 2026
Merged

docs: add version markers to CLI and SDK documentation #149

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
22 changes: 22 additions & 0 deletions phala-cloud/phala-cloud-cli/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@ title: Changelog
description: Release history for the Phala Cloud CLI
---

## [1.1.12](https://github.com/Phala-Network/phala-cloud/compare/cli-v1.1.12-beta.1...cli-v1.1.12) (2026-03-04)

### feat

* **cli:** add --api-version global option ([f96397f](https://github.com/Phala-Network/phala-cloud/commit/f96397f81056af09fb854b3fc99cda09721c5e2f))

### fix

* **cli:** validate --api-version flag against supported versions ([a6b4f68](https://github.com/Phala-Network/phala-cloud/commit/a6b4f684039cf5e676160fcce2bc6f4084e26dee))

## [1.1.12-beta.1](https://github.com/Phala-Network/phala-cloud/compare/cli-v1.1.11...cli-v1.1.12-beta.1) (2026-03-03)

### feat

* **cli:** show changelog URL in self update command ([8f569e8](https://github.com/Phala-Network/phala-cloud/commit/8f569e8c4361848708e2b0e06a423686d9461942))
* **cli:** show changelog URL in update notifications ([22a6648](https://github.com/Phala-Network/phala-cloud/commit/22a6648b5f21384c4675f652bc25bcd6d0bb97e6))

### fix

* **cli:** use --no-cache and exact version for bun global installs ([a63a11d](https://github.com/Phala-Network/phala-cloud/commit/a63a11d19e0b6248e99acf93851c2dabec462fcc))
* **cli:** use generic id field in waitForCvmReady poller ([4b2132d](https://github.com/Phala-Network/phala-cloud/commit/4b2132dd25ef752ada519570efcfb0c744b1cfcb))

## [1.1.11](https://github.com/Phala-Network/phala-cloud/compare/cli-v1.1.10...cli-v1.1.11) (2026-03-02)

### fix
Expand Down
10 changes: 5 additions & 5 deletions phala-cloud/phala-cloud-cli/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ The CLI sends an `X-Phala-Version` header with every request. This determines th
| `2026-01-21` | Default (current) |
| `2025-10-28` | Legacy |

You can override the API version via:
You can override the API version with the `--api-version` global flag *(added in v1.1.12)*:

- The `--api-version` global flag: `phala cvms list --api-version 2025-10-28`
- The `api_version` field in `phala.toml`
```bash
phala apps --api-version 2025-10-28
```

## Authentication

Expand Down Expand Up @@ -137,7 +138,6 @@ Project-level configuration is in `phala.toml` in the working directory. Support
|-------|------|-------------|
| `id` / `uuid` / `app_id` / `instance_id` / `name` | `string` | CVM identifier (any format) |
| `profile` | `string` | Auth profile to use for this project |
| `api_version` | `string` | API version override (e.g., `"2025-10-28"`) |
| `gateway_domain` | `string` | Custom gateway domain |
| `gateway_port` | `number` | Custom gateway port |
| `compose_file` | `string` | Path to Docker Compose file |
Expand All @@ -162,7 +162,7 @@ public_logs = true
|------|-------------|
| `--json` | Output in JSON format for programmatic use |
| `--api-token <token>` | Override the stored API key for this command |
| `--api-version <version>` | Override the API version (e.g., `2025-10-28`, `2026-01-21`) |
| `--api-version <version>` | Override the API version (e.g., `2025-10-28`, `2026-01-21`). *Added in v1.1.12* |

## Related

Expand Down
8 changes: 8 additions & 0 deletions phala-cloud/references/cloud-js-sdk/cvm-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ images.forEach(img => console.log(img.name, img.version));

---

<Note>
`refreshCvmInstanceId` is unreleased — added after `@phala/cloud` v0.2.4. It will be available in a future release.
</Note>

## refreshCvmInstanceId

`POST /cvms/{cvmId}/refresh-instance-id`
Expand All @@ -128,6 +132,10 @@ Generates a new instance ID for a CVM. This invalidates the old instance ID.

---

<Note>
`refreshCvmInstanceIds` is unreleased — added after `@phala/cloud` v0.2.4. It will be available in a future release.
</Note>

## refreshCvmInstanceIds

`POST /cvms/refresh-instance-ids`
Expand Down
4 changes: 4 additions & 0 deletions phala-cloud/references/cloud-js-sdk/cvm-lifecycle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ await client.deleteCvm({ id: "my-app" });

---

<Note>
`replicateCvm` is unreleased — added after `@phala/cloud` v0.2.4. It will be available in a future release.
</Note>

## replicateCvm

`POST /cvms/{cvmId}/replicate`
Expand Down