phala 1.1.0-beta.1 → 1.1.0-beta.11

package/README.md

@@ -63,7 +63,7 @@ ___
    
    To deploy applications to Phala Cloud, you'll need an API key:
 
-   - Visit [Phala Cloud](https://cloud.phala.network/login) to log into your Phala Cloud account. If you do not have an account, registe [here](https://cloud.phala.network/register?invite=beta) or run `npx phala free` in the terminal.
+   - Visit [Phala Cloud](https://cloud.phala.network/login) to log into your Phala Cloud account. If you do not have an account, registe [here](https://cloud.phala.network/register?invite=beta).
    - After logging in, navigate to the "API Keys" section in your profile
    - Create a new API key with an appropriate name (e.g., "CLI Access")
    - Copy the generated API key - you'll need it for authentication
@@ -100,14 +100,14 @@ ___
    #   ⟳ Encrypting environment variables... ✓
    #   ⟳ Creating CVM... ✓
    #   ✓ CVM created successfully
-   #   ℹ CVM ID: 87a117814c8348dba6a51196d256b1fc
+   #   ℹ CVM ID: 2755
    #   ℹ Name: webshell
    #   ℹ Status: creating
    #   ℹ App ID: e15c1a29a9dfb522da528464a8d5ce40ac28039f
-   #   ℹ Endpoint: https://cloud.phala.network/dashboard/cvms/87a117814c8348dba6a51196d256b1fc
+   #   ℹ App URL: <https://cloud.phala.network/dashboard/cvms/app_e15c1a29a9dfb522da528464a8d5ce40ac28039f>
    #    ℹ
    #    ℹ Your CVM is being created. You can check its status with:
-   #    ℹ phala cvms status 87a117814c8348dba6a51196d256b1fc
+   #    ℹ phala cvms status e15c1a29a9dfb522da528464a8d5ce40ac28039f
    ```
 
    Now interact with your application in Phala Cloud by going to the url on port 7681 (Example of what a url at port 7681 would look like https://e15c1a29a9dfb522da528464a8d5ce40ac28039f-7681.dstack-prod5.phala.network)
@@ -165,37 +165,6 @@ phala cvms create --name my-tee-app --compose ./docker-compose.yml --env-file ./
 # Access your app via the provided URL
 ```
 
-### 3️⃣ Simplified Workflow: One-Step On-Chain KMS CVM Creation
-
-Deploy new applications with the `deploy` command:
-
-```bash
-# Basic deployment with interactive prompts
-phala deploy
-
-# Deployment with private key from environment, assume user want to deploy the default AppAuth contract we provide
-export PRIVATE_KEY=your_private_key_here
-phala deploy --kms-id 0x1234...
-
-# Deployment with custom-app-id, assume user already deployed the AppAuth contract onchain
-phala deploy \
-  --kms-id 0xabc123 \
-  --custom-app-id 0x5678... \
-  --pre-launch-script ./pre-launch.sh
-```
-
-### 4️⃣ Upgrade Existing Applications
-
-Upgrade your deployed applications with new configurations:
-
-```bash
-# Basic upgrade with new compose file
-phala cvms upgrade <app-id> --compose docker-compose.prod.yml
-
-# Upgrade with new compose file and environment variables and private key
-phala cvms upgrade <app-id> --compose docker-compose.prod.yml --env-file .env.prod --private-key $PRIVATE_KEY
-```
-
 ## 💼 Real-World Use Cases for Confidential Computing
 
 ### 🏦 Financial Services
@@ -274,18 +243,21 @@ phala auth logout
 #### Status
 
 ```bash
-phala auth status [options]
+phala status [options]
 ```
 
-Check your authentication status with Phala Cloud. Displays user information in a table format.
+Check your authentication status with Phala Cloud. Displays user information including API endpoint, username, and current workspace.
+
+> **Note**: `phala auth status` is still available for backward compatibility, but it's recommended to use `phala status` instead.
 
 **Options:**
 - `-j, --json`: Output in JSON format
+- `-d, --debug`: Enable debug output
 
 **Example:**
 ```bash
-phala auth status
-phala auth status --json
+phala status
+phala status --json
 ```
 
 ### Docker Management Commands
@@ -370,7 +342,15 @@ phala docker generate --image my-tee-app --tag v1.0.0 --env-file ./.env
 
 ### TEE Simulator Commands
 
-Commands for managing the local TEE simulator for development and testing.
+Commands for managing the local TEE simulator for development and testing. When run without subcommands, shows the current status of the simulator.
+
+#### Check Status
+
+```bash
+phala simulator
+```
+
+Shows the current status of the TEE simulator, including the process ID and endpoint information if running.
 
 #### Start Simulator
 
@@ -382,11 +362,17 @@ Start the TEE simulator locally for development and testing.
 
 **Options:**
 
-- `-i, --image <image>`: Simulator image (defaults to 'phalanetwork/tappd-simulator:latest')
+- `-p, --port <port>`: Port to bind the simulator to (default: 8000)
+- `-v, --verbose`: Enable verbose output
+
+**Examples:**
 
-**Example:**
 ```bash
+# Start with default options
 phala simulator start
+
+# Start with verbose output
+phala simulator start --verbose
 ```
 
 #### Stop Simulator
@@ -398,10 +384,22 @@ phala simulator stop
 Stop the running TEE simulator.
 
 **Example:**
+
 ```bash
 phala simulator stop
 ```
 
+#### Environment Variables
+
+When the simulator is running, you'll need to set these environment variables to use it:
+
+```bash
+export DSTACK_SIMULATOR_ENDPOINT=/path/to/dstack.sock
+export TAPPD_SIMULATOR_ENDPOINT=/path/to/tappd.sock
+```
+
+These variables will be automatically displayed when you run `phala simulator` while the simulator is running.
+
 ### Cloud Virtual Machine (CVM) Commands
 
 Commands for managing Cloud Virtual Machines (CVMs) on Phala Cloud.
@@ -448,6 +446,92 @@ Get detailed information about a specific CVM.
 phala cvms get app_123456
 ```
 
+#### Deploy (Simplified)
+
+```bash
+phala deploy [options]
+```
+
+Create a new CVM with automatic resource matching. This is the recommended command for most users as it simplifies deployment by automatically selecting optimal resources based on availability.
+
+**Key Features:**
+- **Auto Resource Matching**: Backend automatically finds the best available node based on your requirements
+- **All Parameters Optional**: Specify only what you need; the system handles the rest
+- **Structured Error Messages**: Clear error codes (ERR-xxxx) with actionable suggestions
+- **On-chain KMS Support**: Built-in support for decentralized key management
+
+**Options:**
+- `-n, --name <name>`: Name of the CVM (auto-generated from folder name if not provided)
+- `-c, --compose <compose>`: Path to Docker Compose file (default: docker-compose.yml)
+- `-t, --instance-type <type>`: Instance type (e.g., tdx.small, tdx.medium, tdx.large) - **optional**, auto-selected if not specified
+- `-r, --region <region>`: Preferred region (e.g., us-west, eu-central) - **optional**, auto-selected if not specified
+- `--vcpu <vcpu>`: Number of vCPUs - **optional**, auto-matched if not specified
+- `--memory <memory>`: Memory with unit (e.g., 2G, 1024MB) - **optional**, auto-matched if not specified
+- `--disk-size <diskSize>`: Disk size with unit (e.g., 50G, 100GB) - **optional**, auto-matched if not specified
+- `--image <image>`: OS image version - **optional**, auto-selected if not specified
+- `--node-id <nodeId>`: Specific node ID - **optional**, auto-selected if not specified
+- `-e, --env-file <envFile>`: Path to environment variables file
+- `-i, --interactive`: Enable interactive mode for required parameters
+- `--kms-id <kmsId>`: KMS ID for on-chain key management
+- `--private-key <key>`: Private key for on-chain KMS deployment
+- `--rpc-url <url>`: RPC URL for blockchain interaction
+- `--uuid <uuid>`: UUID of existing CVM to upgrade
+- `--wait`: Wait for deployment/update to complete before returning
+- `-j, --json`: Output in JSON format
+- `-d, --debug`: Enable debug logging
+
+**Examples:**
+
+```bash
+# Simplest - auto-select everything
+phala deploy
+
+# Specify instance type and region
+phala deploy --instance-type tdx.medium --region us-west
+
+# Manual resource specification
+phala deploy --vcpu 4 --memory 8G --disk-size 100G
+
+# With on-chain KMS
+phala deploy --kms-id ethereum --private-key <key> --rpc-url <url>
+
+# Deploy to specific node (advanced)
+phala deploy --node-id 6
+
+# Interactive mode for guided setup
+phala deploy --interactive
+```
+
+**Error Handling:**
+
+The deploy command provides structured error messages with unique error codes for easy troubleshooting:
+
+```
+Error [ERR-1003]: The selected node does not have enough CPU capacity
+
+Details:
+  - Need 4 CPUs, but only 2 are available
+  - node_id: 6
+
+Suggestions:
+  - Choose a smaller instance type
+  - Reduce the number of CPUs requested
+  - Remove the --node-id flag to search all available nodes
+
+Need help? Contact support: https://cloud.phala.network/contact
+Reference error code: ERR-1003
+```
+
+Common error codes:
+- `ERR-1001`: Instance type not found
+- `ERR-1002`: No available resources match requirements
+- `ERR-1003`: Insufficient CPU capacity
+- `ERR-1004`: Insufficient memory
+- `ERR-2003`: OS image not available
+- `ERR-2005`: Node not accessible
+
+For a complete list of error codes, refer to the error code documentation.
+
 #### Create CVM
 
 ```bash