Skip to main content

​
Usage

phala cvms <subcommand> [args] [options]

​
Subcommands

​
cvms list / cvms ls

List CVMs in your workspace with filtering and pagination.

​
Usage

phala cvms list [options]
phala cvms ls [options]

​
Options

FlagDefaultDescription
--page1Page number for pagination
--page-size30Number of items per page
--search <query>Search CVMs by name or ID
--status <status>Filter by status (repeatable: pending, starting, running, stopping, stopped, error)
--listed / --no-listedFilter by listed status
--base-image <image>Filter by base image
--instance-type <type>Filter by instance type
--kms-type <type>Filter by KMS type
--node <node>Filter by worker node
--region <region>Filter by region
--json / -jfalseJSON output

​
Examples

$ phala cvms list
$ phala cvms ls --status running --status starting
$ phala cvms list --search my-app --json
$ phala cvms ls --region us-west --page 2

​
cvms get

Get detailed information about a specific CVM.

​
Usage

phala cvms get [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM ID, UUID, or name (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--json / -jfalseJSON output
--interactive / -ifalseInteractive mode

​
Examples

$ phala cvms get
$ phala cvms get app_abc123
$ phala cvms get --json
$ phala cvms get --interactive

​
cvms start

Start a stopped CVM.

​
Usage

phala cvms start [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM ID, UUID, or name (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--interactive / -ifalseInteractive mode

​
Examples

$ phala cvms start
$ phala cvms start app_abc123
$ phala cvms start --interactive

​
cvms stop

Stop a running CVM.

​
Usage

phala cvms stop [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM ID, UUID, or name (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--interactive / -ifalseInteractive mode

​
Examples

$ phala cvms stop
$ phala cvms stop app_abc123
$ phala cvms stop --interactive

​
cvms restart

Restart a CVM (stop then start).

​
Usage

phala cvms restart [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM ID, UUID, or name (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--interactive / -ifalseInteractive mode

​
Examples

$ phala cvms restart
$ phala cvms restart app_abc123
$ phala cvms restart --interactive

​
cvms delete

Delete a CVM permanently.

​
Usage

phala cvms delete [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM ID, UUID, or name (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--interactive / -ifalseInteractive mode
--force / -ffalseForce delete without confirmation
--yes / -yfalseSkip confirmation prompt

​
Examples

$ phala cvms delete
$ phala cvms delete app_abc123
$ phala cvms delete --force --yes
$ phala cvms delete --interactive

​
cvms resize

Resize CVM resources (vCPU, memory, disk).

​
Usage

phala cvms resize [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM ID, UUID, or name (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--interactive / -ifalseInteractive mode
--vcpu <cores> / -vNumber of vCPU cores
--memory <mb> / -mMemory in MB
--disk-size <gb> / -dDisk size in GB
--allow-restart / -rfalseAllow CVM restart if required
--yes / -yfalseSkip confirmation prompt
--jsonfalseJSON output

​
Examples

$ phala cvms resize --vcpu 4 --memory 8192
$ phala cvms resize app_abc123 --disk-size 100 --allow-restart
$ phala cvms resize -v 2 -m 4096 -y
$ phala cvms resize --interactive

​
cvms replicate

Create a replica of an existing CVM.

​
Usage

phala cvms replicate [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM UUID to replicate (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--teepod-id <id>Target TeePod ID
--env-file <file> / -eEnvironment file to override variables
--interactive / -ifalseInteractive mode

​
Examples

$ phala cvms replicate
$ phala cvms replicate abc-123-def-456
$ phala cvms replicate --teepod-id pod_xyz --env-file .env.prod
$ phala cvms replicate --interactive

​
cvms attestation

Get CVM attestation data for verification.

​
Usage

phala cvms attestation [cvm-id] [options]

​
Arguments

NameRequiredDescription
cvm-idNoCVM ID, UUID, or name (uses linked CVM if omitted)

​
Options

FlagDefaultDescription
--json / -jfalseJSON output
--interactive / -ifalseInteractive mode

​
Examples

$ phala cvms attestation
$ phala cvms attestation app_abc123
$ phala cvms attestation --json
$ phala cvms attestation --interactive

​
cvms list-nodes

List available worker nodes in the workspace.

​
Usage

phala cvms list-nodes

​
Examples

$ phala cvms list-nodes

​
Deprecated Commands

The following commands are deprecated and have been replaced: These commands may be removed in a future version.