phala 0.0.1-alpha-9 → 0.0.1-alpha-11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -53,20 +53,10 @@ ___
53
53
  > npx phala help
54
54
  > bunx phala help
55
55
  > ```
56
-
57
- or clone source
58
56
 
59
57
  ```bash
60
- # Clone the repository
61
- git clone --recurse-submodules https://github.com/Phala-Network/phala-cloud-cli.git
62
- cd phala-cloud-cli
63
-
64
- # Install and build
65
- bun install
66
- bun run build
67
-
68
58
  # Phala CLI help menu
69
- phala help
59
+ npx phala help
70
60
  ```
71
61
 
72
62
  3. **Sign Up and Get API Key**:
@@ -106,12 +96,6 @@ ___
106
96
  # ✔ Enter memory in MB (default: 2048): 2048
107
97
  # ✔ Enter disk size in GB (default: 20): 20
108
98
  # ⟳ Fetching available TEEPods... ✓
109
- # ? Select a TEEPod: (Use arrow keys)
110
- # ❯ prod5 (online)
111
- # prod2 (online)
112
- # ℹ Selected TEEPod: prod5
113
-
114
- # ✔ Select an image: dstack-dev-0.3.5
115
99
  # ⟳ Getting public key from CVM... ✓
116
100
  # ⟳ Encrypting environment variables... ✓
117
101
  # ⟳ Creating CVM... ✓
@@ -160,11 +144,6 @@ phala docker build --image my-tee-app --tag v1.0.0
160
144
  # Create an environment file
161
145
  echo "API_KEY=test-key" > .env
162
146
  echo "DEBUG=true" >> .env
163
-
164
- # Generate and run Docker Compose
165
- phala docker build-compose --image my-tee-app --tag v1.0.0 --env-file ./.env
166
- phala docker run -c ./phala-compose.yaml -e ./.env
167
-
168
147
  ```
169
148
 
170
149
  ### 2️⃣ Cloud Deployment
@@ -298,21 +277,6 @@ List all available TEEPods on Phala Cloud.
298
277
  phala teepods list
299
278
  ```
300
279
 
301
- #### List TEEPod Images
302
-
303
- ```bash
304
- phala teepods images [options]
305
- ```
306
-
307
- List available images for a specific TEEPod.
308
-
309
- **Options:**
310
- - `-t, --teepod-id <teepodId>`: TEEPod ID (required)
311
-
312
- **Example:**
313
- ```bash
314
- phala teepods images --teepod-id 2
315
- ```
316
280
 
317
281
  ### Docker Management Commands
318
282
 
@@ -372,58 +336,26 @@ Push a Docker image to Docker Hub.
372
336
  phala docker push --image my-tee-app --tag v1.0.0
373
337
  ```
374
338
 
375
- #### List Docker Image Tags
376
-
377
- ```bash
378
- phala docker tags [options]
379
- ```
380
-
381
- List all tags for a Docker image on Docker Hub.
382
-
383
- **Options:**
384
- - `-i, --image <image>`: Image name (required)
385
- - `-j, --json`: Output in JSON format
386
-
387
- **Example:**
388
- ```bash
389
- phala docker tags --image my-tee-app
390
- ```
391
-
392
339
  #### Build Docker Compose File
393
340
 
394
341
  ```bash
395
- phala docker build-compose [options]
342
+ phala docker generate [options]
396
343
  ```
397
344
 
398
345
  Build a Docker Compose file for your TEE application.
399
346
 
400
347
  **Options:**
401
- - `-i, --image <image>`: Image name (required)
402
- - `-t, --tag <tag>`: Image tag (required)
403
- - `-u, --username <username>`: Docker Hub username
404
- - `-e, --env-file <envFile>`: Path to environment file
405
- - `-v, --version <version>`: Template version to use (basic, eliza-v1, eliza-v2)
406
-
407
- **Example:**
408
- ```bash
409
- phala docker build-compose --image my-tee-app --tag v1.0.0 --env-file ./.env
410
- ```
411
-
412
- #### Run Local Docker Compose
413
-
414
- ```bash
415
- phala docker run [options]
416
- ```
417
-
418
- Run a Docker Compose file locally for testing.
419
-
420
- **Options:**
421
- - `-c, --compose <compose>`: Path to Docker Compose file
422
- - `-e, --env-file <envFile>`: Path to environment file
348
+ - -i, --image <image> Docker image name to use in the compose file
349
+ - -t, --tag <tag> Docker image tag to use in the compose file
350
+ - -e, --env-file <envFile> Path to environment variables file
351
+ - -o, --output <output> Output path for generated docker-compose.yml
352
+ - --template <template> Template to use for the generated docker-compose.yml
353
+ - --manual Skip automatic image detection and enter image/tag manually
354
+ - -h, --help display help for command
423
355
 
424
356
  **Example:**
425
357
  ```bash
426
- phala docker run --compose ./tee-compose.yaml --env-file ./.env
358
+ phala docker generate --image my-tee-app --tag v1.0.0 --env-file ./.env
427
359
  ```
428
360
 
429
361
  ### TEE Simulator Commands
@@ -460,63 +392,6 @@ Stop the running TEE simulator.
460
392
  phala simulator stop
461
393
  ```
462
394
 
463
- ### Configuration Commands
464
-
465
- Commands for managing CLI configuration settings.
466
-
467
- #### Get Configuration Value
468
-
469
- ```bash
470
- phala config get <key>
471
- ```
472
-
473
- Get a specific configuration value.
474
-
475
- **Arguments:**
476
- - `key`: Configuration key to retrieve
477
-
478
- **Example:**
479
- ```bash
480
- phala config get apiUrl
481
- ```
482
-
483
- #### Set Configuration Value
484
-
485
- ```bash
486
- phala config set <key> <value>
487
- ```
488
-
489
- Set a configuration value.
490
-
491
- **Arguments:**
492
- - `key`: Configuration key to set
493
- - `value`: Value to set (can be a string, number, boolean, or JSON)
494
-
495
- **Example:**
496
- ```bash
497
- phala config set defaultVcpu 2
498
- phala config set apiUrl "https://custom-api.phala.cloud"
499
- phala config set debug true
500
- phala config set customConfig '{"key": "value", "nested": {"array": [1, 2, 3]}}'
501
- ```
502
-
503
- #### List Configuration Values
504
-
505
- ```bash
506
- phala config list [options]
507
- ```
508
-
509
- List all configuration values.
510
-
511
- **Options:**
512
- - `-j, --json`: Output in JSON format
513
-
514
- **Example:**
515
- ```bash
516
- phala config list
517
- phala config list --json
518
- ```
519
-
520
395
  ### Cloud Virtual Machine (CVM) Commands
521
396
 
522
397
  Commands for managing Cloud Virtual Machines (CVMs) on Phala Cloud.
@@ -524,7 +399,7 @@ Commands for managing Cloud Virtual Machines (CVMs) on Phala Cloud.
524
399
  #### List CVMs
525
400
 
526
401
  ```bash
527
- phala cvms list [options]
402
+ phala cvms list|ls [options]
528
403
  ```
529
404
 
530
405
  List all CVMs associated with your account.
@@ -605,7 +480,7 @@ phala cvms upgrade app_123456 --compose ./new-docker-compose.yml --env-file ./.e
605
480
  #### Start CVM
606
481
 
607
482
  ```bash
608
- phala cvms start <app-id>
483
+ phala cvms start [app-id]
609
484
  ```
610
485
 
611
486
  Start a stopped CVM.
@@ -621,7 +496,7 @@ phala cvms start e15c1a29a9dfb522da528464a8d5ce40ac28039f
621
496
  #### Stop CVM
622
497
 
623
498
  ```bash
624
- phala cvms stop <app-id>
499
+ phala cvms stop [app-id]
625
500
  ```
626
501
 
627
502
  Stop a running CVM.
@@ -637,7 +512,7 @@ phala cvms stop e15c1a29a9dfb522da528464a8d5ce40ac28039f
637
512
  #### Restart CVM
638
513
 
639
514
  ```bash
640
- phala cvms restart <app-id>
515
+ phala cvms restart [app-id]
641
516
  ```
642
517
 
643
518
  Restart a CVM.