Skip to content

docs: update CLI changelog for v1.1.16 #156

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 2 commits into from
Apr 17, 2026
Merged

docs: update CLI changelog for v1.1.16 #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9df989
docs: update CLI changelog for v1.1.16
Leechael Apr 10, 2026
f50fdf8
docs: regenerate CLI deploy command docs for v1.1.16
Leechael Apr 10, 2026
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
10 changes: 10 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,16 @@ title: Changelog
description: Release history for the Phala Cloud CLI
---

## [1.1.16](https://github.com/Phala-Network/phala-cloud/compare/cli-v1.1.15...cli-v1.1.16) (2026-04-10)

### fix

* **cli:** correct deploy --commit requirements in --help ([157f103](https://github.com/Phala-Network/phala-cloud/commit/157f103bb4033cc49abdacc6541d28db15b8a82b))

### refactor

* clarify --help strings and unify --transaction-hash option ([0749dc0](https://github.com/Phala-Network/phala-cloud/commit/0749dc0bc193697ef44d1ac86069d689838b9f58))

## [1.1.15](https://github.com/Phala-Network/phala-cloud/compare/cli-v1.1.14...cli-v1.1.15) (2026-04-10)

### feat
Expand Down
61 changes: 14 additions & 47 deletions phala-cloud/phala-cloud-cli/deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ Deploy new CVM or update existing one

| Option | Description |
| ------ | ----------- |
| `--cvm-id <value>` | CVM identifier (UUID, app_id, instance_id, or name) |
| `-i, --interactive` | Enable interactive mode |
| `-n, --name <value>` | CVM name (defaults to directory name) |
| `-c, --compose <value>` | Path to Docker Compose file (default: docker-compose.yml) |
| `-t, --instance-type <value>` | Instance type (e.g., tdx.small, auto-selected if omitted) |
Expand All @@ -34,18 +32,6 @@ Deploy new CVM or update existing one
| `--public-sysinfo, --no-public-sysinfo` | Make CVM system info publicly accessible (default: true) |
| `--listed, --no-listed` | List CVM on the public Trust Center (default: false) |

### Multisig / Two-Phase Options

For on-chain KMS (Ethereum/Base) with multisig contract owners. See [Multisig Update Flow](#multisig-update-flow).

| Option | Description |
| ------ | ----------- |
| `--prepare-only` | Prepare the update and generate a commit token. Skips all on-chain operations. Intended for multisig workflows. |
| `--commit` | Commit a previously prepared update using a commit token. Requires `--token`; `--compose-hash` and `--transaction-hash` are read from the token when omitted. |
| `--token <value>` | Commit token from a prepare-only update. |
| `--compose-hash <value>` | Compose hash from a prepare-only update. Optional when the token can provide it. |
| `--transaction-hash <value>` | Transaction hash proving on-chain compose hash registration. Pass `already-registered` to skip the proof and rely on state-only verification. |

### Advanced Options

| Option | Description |
Expand All @@ -58,8 +44,13 @@ For on-chain KMS (Ethereum/Base) with multisig contract owners. See [Multisig Up
| `--custom-app-id <value>` | Custom App ID (requires --nonce for PHALA KMS) |
| `--nonce <value>` | Nonce for deterministic app_id (requires --custom-app-id, PHALA KMS only) |
| `--pre-launch-script <value>` | Path to pre-launch script |
| `--private-key <value>` | Private key for signing on-chain transactions (or set `PRIVATE_KEY` env var) |
| `--rpc-url <value>` | RPC URL for on-chain KMS transactions (or set `ETH_RPC_URL` env var) |
| `--private-key <value>` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
| `--rpc-url <value>` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
| `--prepare-only` | Prepare the update and generate a commit token. Skips all on-chain operations. Intended for multisig workflows. |
| `--commit` | Commit a previously prepared update using a commit token. Requires --token; --compose-hash and --transaction-hash are read from the token when omitted. |
| `--token <value>` | Commit token from a prepare-only update. |
| `--compose-hash <value>` | Compose hash from a prepare-only update. Optional in --commit mode when the token can provide it. |
| `--transaction-hash <value>` | Transaction hash proving on-chain compose hash registration. Pass `already-registered` to skip the proof and rely on state-only verification. |

### Deprecated Options

Expand All @@ -79,6 +70,9 @@ For on-chain KMS (Ethereum/Base) with multisig contract owners. See [Multisig Up
| `-v, --version` | Show CLI version |
| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
| `-j, --json, --no-json` | Output in JSON format |
| `-i, --interactive` | Enable interactive mode |
| `--cvm-id <value>` | CVM identifier (UUID, app_id, instance_id, or name) |
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version <value>` | API version to use (e.g. 2025-10-28, 2026-01-21) |

### Examples
Expand Down Expand Up @@ -161,42 +155,15 @@ phala deploy --listed
phala deploy --cvm-id app_123 --no-public-logs
```

### Multisig Update Flow

When the on-chain KMS contract owner is a multisig wallet, the CLI cannot complete the on-chain transaction in a single operation. Use the two-phase flow:

* **Phase 1**: Prepare the update (generate commit token)

```bash
phala deploy --cvm-id app_abc123 --prepare-only -c docker-compose.yml -e .env
```

This outputs the compose hash, on-chain status, and a commit token. The token is valid for 14 days.

* **Phase 2**: After multisig approval and on-chain registration, commit the update
* Prepare update for multisig approval

```bash
phala deploy --cvm-id app_abc123 \
--commit \
--token <commit-token>
phala deploy --cvm-id app_123 --prepare-only -c docker-compose.yml
```

If the compose hash is already registered on-chain, `--transaction-hash` can be omitted (defaults to state-only check).

* With explicit transaction hash
* Commit a prepared update

```bash
phala deploy --cvm-id app_abc123 \
--commit \
--token <commit-token> \
--transaction-hash 0x...
phala deploy --cvm-id app_123 --commit --token <token> --compose-hash 0x... --transaction-hash 0x...
```

* You can also commit via the API directly

```bash
curl -X POST 'https://cloud-api.phala.com/api/v1/cvms/<uuid>/commit-update?token=<commit-token>'
```

Or use the **Confirm Update** page in the dashboard (link provided in `--prepare-only` output).

Loading