Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
136 changes: 80 additions & 56 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,6 @@
"/phala-cloud/phala-cloud-cli/start-from-cloud-cli",
"/phala-cloud/phala-cloud-cli/phala-toml",
"/phala-cloud/phala-cloud-cli/ci-cd-automation/setup-a-ci-cd-pipeline",
"/phala-cloud/phala-cloud-cli/changelog",
{
"group": "Deploy",
"pages": [
Expand All @@ -254,7 +253,17 @@
]
},
{
"group": "Manage",
"group": "CVM Operations",
"pages": [
"/phala-cloud/phala-cloud-cli/cp",
"/phala-cloud/phala-cloud-cli/logs",
"/phala-cloud/phala-cloud-cli/ps",
"/phala-cloud/phala-cloud-cli/runtime-config",
"/phala-cloud/phala-cloud-cli/ssh"
]
},
{
"group": "Resources",
"pages": [
"/phala-cloud/phala-cloud-cli/apps",
{
Expand All @@ -271,7 +280,6 @@
"pages": [
"/phala-cloud/phala-cloud-cli/cvms",
"/phala-cloud/phala-cloud-cli/cvms/attestation",
"/phala-cloud/phala-cloud-cli/cvms/create",
"/phala-cloud/phala-cloud-cli/cvms/delete",
"/phala-cloud/phala-cloud-cli/cvms/device-allowlist",
"/phala-cloud/phala-cloud-cli/cvms/get",
Expand All @@ -295,15 +303,6 @@
"/phala-cloud/phala-cloud-cli/envs/update"
]
},
"/phala-cloud/phala-cloud-cli/link",
{
"group": "simulator",
"pages": [
"/phala-cloud/phala-cloud-cli/simulator",
"/phala-cloud/phala-cloud-cli/simulator/start",
"/phala-cloud/phala-cloud-cli/simulator/stop"
]
},
{
"group": "ssh-keys",
"pages": [
Expand All @@ -313,19 +312,32 @@
"/phala-cloud/phala-cloud-cli/ssh-keys/remove",
"/phala-cloud/phala-cloud-cli/ssh-keys/import-github"
]
},
{
"group": "allow-devices",
"pages": [
"/phala-cloud/phala-cloud-cli/allow-devices",
"/phala-cloud/phala-cloud-cli/allow-devices/list",
"/phala-cloud/phala-cloud-cli/allow-devices/add",
"/phala-cloud/phala-cloud-cli/allow-devices/remove",
"/phala-cloud/phala-cloud-cli/allow-devices/allow-any",
"/phala-cloud/phala-cloud-cli/allow-devices/disallow-any",
"/phala-cloud/phala-cloud-cli/allow-devices/toggle-allow-any"
]
},
{
"group": "kms",
"pages": [
"/phala-cloud/phala-cloud-cli/kms",
"/phala-cloud/phala-cloud-cli/kms/list",
"/phala-cloud/phala-cloud-cli/kms/nodes",
"/phala-cloud/phala-cloud-cli/kms/ethereum",
"/phala-cloud/phala-cloud-cli/kms/base",
"/phala-cloud/phala-cloud-cli/kms/phala"
]
}
]
},
{
"group": "CVM Operations",
"pages": [
"/phala-cloud/phala-cloud-cli/cp",
"/phala-cloud/phala-cloud-cli/logs",
"/phala-cloud/phala-cloud-cli/ps",
"/phala-cloud/phala-cloud-cli/runtime-config",
"/phala-cloud/phala-cloud-cli/ssh"
]
},
{
"group": "Profile & Auth",
"pages": [
Expand All @@ -342,35 +354,29 @@
},
"/phala-cloud/phala-cloud-cli/status",
"/phala-cloud/phala-cloud-cli/switch",
"/phala-cloud/phala-cloud-cli/whoami"
"/phala-cloud/phala-cloud-cli/whoami",
"/phala-cloud/phala-cloud-cli/link"
]
},
{
"group": "Advanced",
"group": "Dev Tools",
"pages": [
{
"group": "allow-devices",
"pages": [
"/phala-cloud/phala-cloud-cli/allow-devices",
"/phala-cloud/phala-cloud-cli/allow-devices/list",
"/phala-cloud/phala-cloud-cli/allow-devices/add",
"/phala-cloud/phala-cloud-cli/allow-devices/remove",
"/phala-cloud/phala-cloud-cli/allow-devices/allow-any",
"/phala-cloud/phala-cloud-cli/allow-devices/disallow-any",
"/phala-cloud/phala-cloud-cli/allow-devices/toggle-allow-any"
]
},
"/phala-cloud/phala-cloud-cli/api",
"/phala-cloud/phala-cloud-cli/completion",
{
"group": "kms",
"group": "simulator",
"pages": [
"/phala-cloud/phala-cloud-cli/kms",
"/phala-cloud/phala-cloud-cli/kms/list",
"/phala-cloud/phala-cloud-cli/kms/ethereum",
"/phala-cloud/phala-cloud-cli/kms/base"
"/phala-cloud/phala-cloud-cli/simulator",
"/phala-cloud/phala-cloud-cli/simulator/start",
"/phala-cloud/phala-cloud-cli/simulator/stop"
]
},
"/phala-cloud/phala-cloud-cli/keccak256sum"
]
},
{
"group": "Misc",
"pages": [
"/phala-cloud/phala-cloud-cli/completion",
{
"group": "self",
"pages": [
Expand All @@ -380,6 +386,7 @@
}
]
},
"/phala-cloud/phala-cloud-cli/changelog",
{
"group": "Deprecated",
"pages": [
Expand All @@ -400,17 +407,6 @@
"/phala-cloud/phala-cloud-cli/config/list",
"/phala-cloud/phala-cloud-cli/config/set"
]
},
{
"group": "docker",
"pages": [
"/phala-cloud/phala-cloud-cli/docker",
"/phala-cloud/phala-cloud-cli/docker/login",
"/phala-cloud/phala-cloud-cli/docker/build",
"/phala-cloud/phala-cloud-cli/docker/push",
"/phala-cloud/phala-cloud-cli/docker/generate",
"/phala-cloud/phala-cloud-cli/docker/run"
]
}
]
}
Expand Down Expand Up @@ -1020,9 +1016,37 @@
"source": "/phala-cloud/references/phala-cloud-cli/phala/config"
},
{
"destination": "/phala-cloud/phala-cloud-cli/docker",
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/references/phala-cloud-cli/phala/docker"
},
{
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/phala-cloud-cli/docker"
},
{
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/phala-cloud-cli/docker/login"
},
{
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/phala-cloud-cli/docker/build"
},
{
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/phala-cloud-cli/docker/push"
},
{
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/phala-cloud-cli/docker/generate"
},
{
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/phala-cloud-cli/docker/run"
},
{
"destination": "/phala-cloud/phala-cloud-cli/deploy",
"source": "/phala-cloud/phala-cloud-cli/cvms/create"
},
{
"destination": "/phala-cloud/phala-cloud-cli/simulator",
"source": "/phala-cloud/references/phala-cloud-cli/phala/simulator"
Expand Down Expand Up @@ -1116,7 +1140,7 @@
"source": "/phala-cloud/phala-cloud-user-guides/create-cvm/create-with-private-docker-image"
},
{
"destination": "/phala-cloud/phala-cloud-cli/docker",
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/references/tee-cloud-cli/phala/docker"
},
{
Expand All @@ -1128,7 +1152,7 @@
"source": "/phala-cloud/phala-cloud-user-guides/advanced-deployment-options"
},
{
"destination": "/phala-cloud/phala-cloud-cli/docker",
"destination": "/phala-cloud/phala-cloud-cli/overview",
"source": "/phala-cloud/references/tee-cloud-cli"
},
{
Expand Down
20 changes: 20 additions & 0 deletions phala-cloud/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,26 @@ rss: true
noindex: true
---

<Update label="July 25-26, 2026" tags={["SDK", "CLI", "KMS"]} rss={{ title: "New SDK and CLI Releases", description: "Contract-centric KMS APIs, measurement helpers, and updated CLI command references" }}>

## SDK Releases

- **JavaScript v0.4.0**: Added contract-centric KMS methods, `mr_config_id` helpers, richer CVM status models, and API version `2026-06-23` as the default.
- **Python v0.2.0**: Added sync and async KMS contract methods, measurement helpers, typed attestations, and typed batch CVM status responses.
- **Go v0.2.0**: Added KMS contract methods, measurement helpers, app instance creation, revision redeployment, and versioned CVM response support.
- **CVM List Filters**: JavaScript and Python now reject the removed `user_id`, `teepod_id`, and `node_id` list filters.

## CLI v1.1.20

- **KMS Discovery**: Added commands to list KMS contracts, inspect contract nodes, and show the Phala KMS.
- **Deployment Controls**: Added forced-stop updates, KMS verification anchors, and `mr_config_id` output.
- **Hash Utility**: Added `phala keccak256sum` with stdin and checksum verification modes.
- **Removed Commands**: Removed `phala docker` and `phala cvms create`. Use `phala deploy` to create CVMs.

See the [CLI changelog](/phala-cloud/phala-cloud-cli/changelog) and the [JavaScript](/phala-cloud/references/cloud-js-sdk/changelog), [Python](/phala-cloud/references/cloud-python-sdk/changelog), and [Go](/phala-cloud/references/cloud-go-sdk/changelog) SDK changelogs for details.

</Update>

<Update label="April 27 - May 1, 2026" tags={["Workspace", "Billing", "KMS", "Admin", "Gateways"]} rss={{ title: "Workspace Abandonment & On-Chain KMS Clusters", description: "Abandoned workspace lockdown, on-chain KMS cluster relations, admin gateway surface, and global ApiErrorDialog" }}>

## Workspace Suspension & Abandonment
Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/allow-devices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ Manage on-chain device allowlist for an app contract
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

#### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/allow-devices/add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ Add devices to the on-chain allowlist
| `-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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/allow-devices/allow-any.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ Set the allow-any-device flag on the contract. Requires --enable or --disable.
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/allow-devices/disallow-any.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ Disable allow-any-device on the contract. Equivalent to `allow-any --disable`.
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/allow-devices/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ List allowed devices from the on-chain contract
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/allow-devices/remove.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ Remove devices from the on-chain allowlist
| `-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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ Toggle allow-any-device on the contract (or force via --enable/--disable)
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
7 changes: 2 additions & 5 deletions phala-cloud/phala-cloud-cli/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ title: "api"
description: "Make an authenticated HTTP request to Phala Cloud API."
---

<Note>
This command is marked as unstable and may change in future releases.
</Note>

### Command: `phala api`

#### Syntax
Expand Down Expand Up @@ -49,7 +45,8 @@ Make an authenticated HTTP request to Phala Cloud API.
| `-j, --json, --no-json` | Output in JSON format |
| `--interactive` | Enable interactive mode for commands that support it |
| `--cvm-id <value>` | CVM identifier (UUID, app_id, instance_id, or name) |
| `--api-version <value>` | API version to use (e.g. 2025-10-28, 2026-01-21) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

#### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ List dstack apps
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

#### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ Authenticate with Phala Cloud
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

#### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/auth/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ Authenticate with Phala Cloud (use 'phala login' instead)
| `-j, --json, --no-json` | Output in JSON format |
| `--interactive` | Enable interactive mode for commands that support it |
| `--cvm-id <value>` | CVM identifier (UUID, app_id, instance_id, or name) |
| `--api-version <value>` | API version to use (e.g. 2025-10-28, 2026-01-21) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/auth/logout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ Remove stored API key (use 'phala logout' instead)
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
3 changes: 2 additions & 1 deletion phala-cloud/phala-cloud-cli/auth/status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ Check auth status (use 'phala status' instead)
| `--interactive` | Enable interactive mode for commands that support it |
| `--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) |
| `--api-version <value>` | API version to use (e.g. 2026-01-21, 2026-05-22, 2026-06-23) |
| `--timeout SECONDS` | Request timeout in seconds (default 60) |

### Examples

Expand Down
Loading
Loading