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
294 changes: 155 additions & 139 deletions docs.json

Large diffs are not rendered by default.

15,809 changes: 7,380 additions & 8,429 deletions openapi.json

Large diffs are not rendered by default.

23 changes: 12 additions & 11 deletions phala-cloud/phala-cloud-cli/allow-devices.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
---
title: "allow-devices"
description: "Manage on-chain device allowlist for an app contract"
hidden: true
---

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

## Command: `phala allow-devices`
### Command: `phala allow-devices`

### Syntax
#### Syntax

```
phala allow-devices <command> [options]
```

### Description
#### Description

Manage on-chain device allowlist for an app contract

### Global Options
#### Global Options

| Option | Description |
| ------ | ----------- |
Expand All @@ -32,6 +33,13 @@ Manage on-chain device allowlist for an app contract
| `--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

* Display help:

```bash
phala allow-devices --help
```
### Subcommands

| Command | Description |
Expand All @@ -43,10 +51,3 @@ Manage on-chain device allowlist for an app contract
| `disallow-any` | Disable allow-any-device on the contract. Equivalent to `allow-any --disable`. |
| `toggle-allow-any` | Toggle allow-any-device on the contract (or force via --enable/--disable) |

### Examples

* Display help:

```bash
phala allow-devices --help
```
68 changes: 68 additions & 0 deletions phala-cloud/phala-cloud-cli/allow-devices/add.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: "allow-devices add"
description: "Add devices to the on-chain allowlist"
---

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

## Command: `phala allow-devices add`

### Syntax

```
phala allow-devices add [options] <cvm> [<device_id>]
```

### Description

Add devices to the on-chain allowlist

### Arguments

| Argument | Description |
| -------- | ----------- |
| `<cvm>` | CVM or app identifier (UUID, app_id, instance_id, or name) |
| `<device_id>?` | Device ID (bytes32 hex) or node name. Node names are resolved to device IDs from available nodes. |

### Options

| Option | Description |
| ------ | ----------- |
| `--wait` | Wait for on-chain state to reflect the change via RPC polling |

### Advanced Options

| Option | Description |
| ------ | ----------- |
| `--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) |

### Global Options

| Option | Description |
| ------ | ----------- |
| `-h, --help` | Show help information for the current command |
| `-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

* Add device to allowlist

```bash
phala allow-devices add app_abc123 0xaabb... --private-key 0x...
```

* Interactive multi-select from available nodes

```bash
phala allow-devices add app_abc123 -i --private-key 0x...
```

69 changes: 69 additions & 0 deletions phala-cloud/phala-cloud-cli/allow-devices/allow-any.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: "allow-devices allow-any"
description: "Set the allow-any-device flag on the contract. Requires --enable or --disable."
---

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

## Command: `phala allow-devices allow-any`

### Syntax

```
phala allow-devices allow-any [options] <cvm>
```

### Description

Set the allow-any-device flag on the contract. Requires --enable or --disable.

### Arguments

| Argument | Description |
| -------- | ----------- |
| `<cvm>` | CVM or app identifier (UUID, app_id, instance_id, or name) |

### Options

| Option | Description |
| ------ | ----------- |
| `--enable` | Enable allow-any-device |
| `--disable` | Disable allow-any-device |
| `--wait` | Wait for on-chain state to reflect the change via RPC polling |

### Advanced Options

| Option | Description |
| ------ | ----------- |
| `--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) |

### Global Options

| Option | Description |
| ------ | ----------- |
| `-h, --help` | Show help information for the current command |
| `-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 |
| `--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) |

### Examples

* Enable allow-any-device

```bash
phala allow-devices allow-any app_abc123 --enable --private-key 0x...
```

* Disable allow-any-device

```bash
phala allow-devices allow-any app_abc123 --disable --private-key 0x...
```

61 changes: 61 additions & 0 deletions phala-cloud/phala-cloud-cli/allow-devices/disallow-any.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "allow-devices disallow-any"
description: "Disable allow-any-device on the contract. Equivalent to `allow-any --disable`."
---

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

## Command: `phala allow-devices disallow-any`

### Syntax

```
phala allow-devices disallow-any [options] <cvm>
```

### Description

Disable allow-any-device on the contract. Equivalent to `allow-any --disable`.

### Arguments

| Argument | Description |
| -------- | ----------- |
| `<cvm>` | CVM or app identifier (UUID, app_id, instance_id, or name) |

### Options

| Option | Description |
| ------ | ----------- |
| `--wait` | Wait for on-chain state to reflect the change via RPC polling |

### Advanced Options

| Option | Description |
| ------ | ----------- |
| `--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) |

### Global Options

| Option | Description |
| ------ | ----------- |
| `-h, --help` | Show help information for the current command |
| `-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 |
| `--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) |

### Examples

* Disable allow-any-device

```bash
phala allow-devices disallow-any app_abc123 --private-key 0x...
```

54 changes: 54 additions & 0 deletions phala-cloud/phala-cloud-cli/allow-devices/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: "allow-devices list"
description: "List allowed devices from the on-chain contract"
---

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

## Command: `phala allow-devices list`

### Syntax

```
phala allow-devices list [options] <cvm>
```

### Description

List allowed devices from the on-chain contract

### Arguments

| Argument | Description |
| -------- | ----------- |
| `<cvm>` | CVM or app identifier (UUID, app_id, instance_id, or name) |

### Advanced Options

| Option | Description |
| ------ | ----------- |
| `--rpc-url <value>` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |

### Global Options

| Option | Description |
| ------ | ----------- |
| `-h, --help` | Show help information for the current command |
| `-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 |
| `--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) |

### Examples

* List devices on-chain

```bash
phala allow-devices list app_abc123
```

68 changes: 68 additions & 0 deletions phala-cloud/phala-cloud-cli/allow-devices/remove.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: "allow-devices remove"
description: "Remove devices from the on-chain allowlist"
---

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

## Command: `phala allow-devices remove`

### Syntax

```
phala allow-devices remove [options] <cvm> [<device_id>]
```

### Description

Remove devices from the on-chain allowlist

### Arguments

| Argument | Description |
| -------- | ----------- |
| `<cvm>` | CVM or app identifier (UUID, app_id, instance_id, or name) |
| `<device_id>?` | Device ID (bytes32 hex) or node name. Node names are resolved to device IDs from available nodes. |

### Options

| Option | Description |
| ------ | ----------- |
| `--wait` | Wait for on-chain state to reflect the change via RPC polling |

### Advanced Options

| Option | Description |
| ------ | ----------- |
| `--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) |

### Global Options

| Option | Description |
| ------ | ----------- |
| `-h, --help` | Show help information for the current command |
| `-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

* Remove device from allowlist

```bash
phala allow-devices remove app_abc123 0xaabb... --private-key 0x...
```

* Interactive multi-select from allowed devices

```bash
phala allow-devices remove app_abc123 -i --private-key 0x...
```

Loading
Loading