Skip to main content

​
Prerequisites

You will need the following to use the CLI:

​
Install CLI

Install via npm or use npx/bunx 
# Install the CLI globally
npm install -g phala

​
Sign Up and Get API Key

To deploy applications to Phala Cloud, you’ll need an API key:
  • Visit Phala Cloud to log into your Phala Cloud account. If you do not have an account, register here.
  • After logging in, navigate to “User Avatar (right top corner) > API Tokens”
  • Create a new API Token with an appropriate name (e.g., “CLI Access”)
  • Copy the generated API key - you’ll need it for authentication
  • You can verify your API key using: 
    phala auth login [your-phala-cloud-api-key]
phala auth status

​
Deploy Your First TEE App

# Deploy the webshell Dstack example
phala cvms create
Provide a name and select from the drop down of examples 
# ? Enter a name for the CVM: webshell
# ? Choose a Docker Compose example or enter a custom path:

#  lightclient
#   private-docker-image-deployment
#   ❯ webshell
#   custom-domain
#   prelaunch-script
#   timelock-nts
#   ssh-over-tproxy
#   Using example: webshell (~/phala-cloud-cli/examples/webshell/docker-compose.yaml)
#   ✔ Enter number of vCPUs (default: 1): 1

#   ✔ Enter memory in MB (default: 2048): 2048
#   ✔ Enter disk size in GB (default: 20): 20
#   ⟳ Fetching available TEEPods... ✓
#   ? Select a TEEPod: (Use arrow keys)
#   ❯ prod5 (online)
#   prod2 (online)
#   ℹ Selected TEEPod: prod5

#   ✔ Select an image: dstack-dev-0.3.5
#   ⟳ Getting public key from CVM... ✓
#   ⟳ Encrypting environment variables... ✓
#   ⟳ Creating CVM... ✓
#   ✓ CVM created successfully
#   ℹ CVM ID: 2755
#   ℹ Name: webshell
#   ℹ Status: creating
#   ℹ App ID: e15c1a29a9dfb522da528464a8d5ce40ac28039f
#   ℹ App URL: <https://cloud.phala.network/dashboard/cvms/app_e15c1a29a9dfb522da528464a8d5ce40ac28039f>
#    ℹ
#    ℹ Your CVM is being created. You can check its status with:
#    ℹ 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)

​
Check Attestation

phala cvms attestation

# ℹ No CVM specified, fetching available CVMs...
# ⟳ Fetching available CVMs... ✓
# ✔ Select a CVM: testing (88721d1685bcd57166a8cbe957cd16f733b3da34) - Status: running
# ℹ Fetching attestation information for CVM 88721d1685bcd57166a8cbe957cd16f733b3da34...
# ⟳ Fetching attestation information... ✓
# ✓ Attestation Summary:

# or list the app-id
phala cvms attestation 88721d1685bcd57166a8cbe957cd16f733b3da34

​
🏗️ Development Workflow

​
1️⃣ Local Development

Develop and test your application locally with the built-in TEE simulator: 
# Start the TEE simulator
phala simulator start

# Build your Docker image
phala docker build --image my-tee-app --tag v1.0.0

# Create an environment file
echo "API_KEY=test-key" > .env
echo "DEBUG=true" >> .env

# Generate and run Docker Compose
phala docker build-compose --image my-tee-app --tag v1.0.0 --env-file ./.env
phala docker run -c ./phala-compose.yaml -e ./.env

​
2️⃣ Cloud Deployment

Deploy your application to Phala’s decentralized TEE Cloud: 
# Set your Phala Cloud API key
phala auth login

# Login to Docker and Push your image to Docker Hub
phala docker login
phala docker build --image my-tee-app --tag v1.0.0
phala docker push --image my-tee-app --tag v1.0.0

# Deploy to Phala Cloud
phala cvms create --name my-tee-app --compose ./docker-compose.yml --env-file ./.env

# Access your app via the provided URL

​
🔍 Troubleshooting

Common issues and solutions:
  1. Docker Build Fails
    • Verify Docker daemon is running
    • Check Dockerfile path
    • Ensure proper permissions
  2. Simulator Issues
    • Check if port 8090 is available
    • Verify Docker permissions
  3. Cloud Deployment Fails
    • Validate API key
    • Confirm image exists on Docker Hub
    • Check environment variables
For detailed help: 
phala --help
phala <command> --help
⌘I