@elizaos/cli 1.0.0-beta.76 → 1.0.0

package/README.md

@@ -5,7 +5,7 @@ The ElizaOS CLI provides a comprehensive set of commands to manage your ElizaOS
 ## Installation
 
 ```bash
-bun install -g @elizaos/cli@beta
+bun install -g @elizaos/cli
 ```
 
 ### Alternative usage with npx
@@ -13,7 +13,7 @@ bun install -g @elizaos/cli@beta
 You can also run the CLI directly without installation using npx:
 
 ```bash
-npx @elizaos/cli@beta [command]
+npx @elizaos/cli [command]
 ```
 
 This is useful for trying out commands without installing the CLI globally.
@@ -22,9 +22,7 @@ This is useful for trying out commands without installing the CLI globally.
 
 Below is a comprehensive reference for all ElizaOS CLI commands, including their options, arguments, and subcommands. For the most up-to-date usage, run `elizaos [command] --help`.
 
-### Project Creation
-
-#### `elizaos create [name]`
+### `elizaos create [name]`
 
 Initialize a new project, plugin, or agent.
 
@@ -45,13 +43,13 @@ Initialize a new project, plugin, or agent.
 
 #### `elizaos dev`
 
-Start the project or plugin in development mode and rebuild on file changes.
+Start the project or plugin in development mode with auto-rebuild, detailed logging, and file change detection.
 
 - **Options:**
-  - `-c, --configure`: Reconfigure services and AI models
+  - `-c, --configure`: Reconfigure services and AI models (skips using saved configuration)
   - `-char, --character [paths...]`: Character file(s) to use - accepts paths or URLs
   - `-b, --build`: Build the project before starting
-  - `-p, --port <port>`: Port number to run the server on
+  - `-p, --port <port>`: Port to listen on
 
 **Character Handling:**
 
@@ -94,10 +92,10 @@ Manage environment variables and secrets.
 
 #### `elizaos setup-monorepo`
 
-Clone ElizaOS monorepo from a specific branch (defaults to v2-develop).
+Clone ElizaOS monorepo from a specific branch (defaults to main).
 
 - **Options:**
-  - `-b, --branch <branch>`: Branch to install (default: `v2-develop`)
+  - `-b, --branch <branch>`: Branch to install (default: `main`)
   - `-d, --dir <directory>`: Destination directory (default: `./eliza`)
 
 **Notes:**
@@ -112,12 +110,13 @@ Clone ElizaOS monorepo from a specific branch (defaults to v2-develop).
 Manage an ElizaOS plugin.
 
 - **Subcommands:**
-  - `list` (aliases: `l`, `ls`): List all available plugins
+  - `list` (alias: `l`): List all available plugins
   - `add <plugin>` (alias: `install`): Add a plugin to the project
     - Arguments: `<plugin>` (plugin name)
-    - Options: `-n, --no-env-prompt`, `-b, --branch <branchName>`
+    - Options: `-n, --no-env-prompt`, `-b, --branch <branchName>`, `-T, --tag <tagname>`
+  - `update` (alias: `refresh`): Fetch the latest plugin registry and update local cache
   - `installed-plugins`: List plugins found in the project dependencies
-  - `remove <plugin>` (aliases: `delete`, `del`, `rm`): Remove a plugin from the project
+  - `remove <plugin>` (alias: `delete`): Remove a plugin from the project
     - Arguments: `<plugin>` (plugin name)
 
 ### Agent Management
@@ -128,29 +127,42 @@ Manage ElizaOS agents.
 
 - **Subcommands:**
   - `list` (alias: `ls`): List available agents
-    - Options: `-j, --json` (output as JSON)
+    - Options:
+      - `-j, --json`: Output as JSON
+      - `-r, --remote-url <url>`: URL of the remote agent runtime
+      - `-p, --port <port>`: Port to listen on
   - `get` (alias: `g`): Get agent details
     - Options:
-      - `-n, --name <n>`: Agent id, name, or index number from list
+      - `-n, --name <name>`: Agent id, name, or index number from list
       - `-j, --json`: Display JSON output in terminal
       - `-o, --output <file>`: Save agent data to file
+      - `-r, --remote-url <url>`: URL of the remote agent runtime
+      - `-p, --port <port>`: Port to listen on
   - `start` (alias: `s`): Start an agent
     - Options:
-      - `-n, --name <n>`: Name of an existing agent to start
+      - `-n, --name <name>`: Name of an existing agent to start
       - `-j, --json <json>`: Character JSON configuration string
       - `--path <path>`: Local path to character JSON file
       - `--remote-character <url>`: URL to remote character JSON file
+      - `-r, --remote-url <url>`: URL of the remote agent runtime
+      - `-p, --port <port>`: Port to listen on
   - `stop` (alias: `st`): Stop an agent
     - Options:
-      - `-n, --name <n>`: Agent id, name, or index number from list
+      - `-n, --name <name>`: Agent id, name, or index number from list
+      - `-r, --remote-url <url>`: URL of the remote agent runtime
+      - `-p, --port <port>`: Port to listen on
   - `remove` (alias: `rm`): Remove an agent
     - Options:
-      - `-n, --name <n>`: Agent id, name, or index number from list
+      - `-n, --name <name>`: Agent id, name, or index number from list
+      - `-r, --remote-url <url>`: URL of the remote agent runtime
+      - `-p, --port <port>`: Port to listen on
   - `set`: Update agent configuration
     - Options:
-      - `-n, --name <n>`: Agent id, name, or index number from list
+      - `-n, --name <name>`: Agent id, name, or index number from list
       - `-c, --config <json>`: Agent configuration as JSON string
       - `-f, --file <path>`: Path to agent configuration JSON file
+      - `-r, --remote-url <url>`: URL of the remote agent runtime
+      - `-p, --port <port>`: Port to listen on
 
 **Note:** All agent commands support interactive mode when run without key parameters.
 
@@ -158,12 +170,34 @@ Manage ElizaOS agents.
 
 #### `elizaos publish`
 
-Publish a plugin or project to the registry, GitHub, or npm.
+Publish a plugin to the registry.
 
 - **Options:**
-  - `-t, --test`: Run publish tests without actually publishing
-  - `-n, --npm`: Publish to npm
-  - `-s, --skip-registry`: Skip publishing to the registry
+  - `-t, --test`: Test publish process without making changes
+  - `-n, --npm`: Publish to npm instead of GitHub
+  - `-sr, --skip-registry`: Skip publishing to the registry
+  - `-d, --dry-run`: Generate registry files locally without publishing
+
+**Default behavior:**
+
+- Publishes to npm
+- Creates/updates GitHub repository
+- Submits to ElizaOS registry
+
+**npm-only mode:**
+
+- Use `--npm` flag to publish only to npm
+- Skips GitHub repository creation and registry submission
+
+**Important for continuous development:**
+
+The `elizaos publish` command is designed for **initial plugin publishing only**. After initial publishing, use standard npm and git workflows for updates:
+
+- `npm version patch|minor|major` to update version
+- `npm publish` to publish to npm
+- `git push origin main && git push --tags` to update GitHub
+
+The ElizaOS registry automatically syncs with npm updates.
 
 ### Agent/Server Management
 
@@ -172,7 +206,7 @@ Publish a plugin or project to the registry, GitHub, or npm.
 Start the Eliza agent with configurable plugins and services.
 
 - **Options:**
-  - `-c, --configure`: Force reconfiguration of services and AI models
+  - `-c, --configure`: Force reconfiguration of services and AI models (bypasses saved configuration)
   - `-char, --character [paths...]`: Character file(s) to use - accepts paths or URLs
   - `-b, --build`: Build the project before starting
   - `-p, --port <port>`: Port to listen on (default: 3000)
@@ -223,20 +257,209 @@ Run tests for Eliza agent plugins and projects.
 
 #### `elizaos tee phala <subcommand>`
 
-Manage TEE deployments with Phala vendor.
+Manage TEE deployments using the official [Phala Cloud CLI](https://docs.phala.network/phala-cloud/references/tee-cloud-cli). This integration provides seamless access to Phala's decentralized TEE cloud infrastructure directly through the ElizaOS CLI.
 
-- **Subcommands:**
-  - `deploy`: Deploy to TEE cloud
-    - Options: `-t, --type <type>`, `-m, --mode <mode>`, `-n, --name <n>`, `-c, --compose <compose>`, `-e, --env <env...>`, `--env-file <envFile>`, `--debug`
-  - `teepods`: Query the teepods
-  - `images`: Query the images
-    - Options: `--teepod-id <teepodId>`
-  - `upgrade`: Upgrade the TEE CLI
-    - Options: `-m, --mode <mode>`, `--app-id <appId>`, `-e, --env <env...>`, `--env-file <envFile>`, `-c, --compose <compose>`
-  - `build-compose`: Build a docker-compose file for Eliza Agent
-    - Options: `-i, --image <n>`, `-u, --username <n>`, `-t, --tag <tag>`, `-c, --character <path>`, `-e, --env-file <path>`, `-v, --version <version>`
-  - `publish`: Publish Docker image to Docker Hub
-    - Options: `-i, --image <n>`, `-u, --username <n>`, `-t, --tag <tag>`
+All Phala Cloud CLI commands are passed through transparently, allowing you to use the full functionality of Phala's TEE platform.
+
+```bash
+elizaos tee phala <command> [options]
+```
+
+##### Main Commands
+
+- **`elizaos tee phala help`** - Display help for all commands
+- **`elizaos tee phala join` (alias: `free`)** - Join Phala Cloud! Get an account and deploy a CVM for FREE
+- **`elizaos tee phala demo`** - Launch demo applications on Phala Cloud (Jupyter Notebook, HTTPBin)
+
+##### Authentication Commands (`elizaos tee phala auth`)
+
+- **`elizaos tee phala auth login [api-key]`** - Set the API key for authentication
+
+  - Store your Phala Cloud API key securely for subsequent operations
+  - Get your API key from [Phala Cloud Dashboard](https://cloud.phala.network)
+
+- **`elizaos tee phala auth logout`** - Remove the stored API key
+
+- **`elizaos tee phala auth status`** - Check authentication status
+  - Displays whether you're logged in and which account is active
+
+##### Cloud Virtual Machine Management (`elizaos tee phala cvms`)
+
+- **`elizaos tee phala cvms list` (alias: `ls`)** - List all CVMs
+
+  - Options:
+    - `-j, --json` - Output in JSON format
+
+- **`elizaos tee phala cvms create`** - Create a new CVM
+
+  - Options:
+    - `-n, --name <name>` - Name of the CVM
+    - `-c, --compose <compose>` - Path to Docker Compose file
+    - `--vcpu <vcpu>` - Number of vCPUs (default: 2)
+    - `--memory <memory>` - Memory in MB (default: 4096)
+    - `--disk-size <diskSize>` - Disk size in GB (default: 40)
+    - `--teepod-id <teepodId>` - TEEPod ID to use (will prompt if not provided)
+    - `--image <image>` - Version of dstack image to use (will prompt if not provided)
+    - `-e, --env-file <envFile>` - Path to environment file
+    - `--skip-env` - Skip environment variable prompt (default: false)
+    - `--debug` - Enable debug mode (default: false)
+
+- **`elizaos tee phala cvms get [app-id]`** - Get details of a CVM
+
+  - Options:
+    - `-j, --json` - Output in JSON format
+
+- **`elizaos tee phala cvms start [app-id]`** - Start a stopped CVM
+
+  - Interactive selection if app-id not provided
+
+- **`elizaos tee phala cvms stop [app-id]`** - Stop a running CVM
+
+  - Interactive selection if app-id not provided
+
+- **`elizaos tee phala cvms restart [app-id]`** - Restart a CVM
+
+  - Interactive selection if app-id not provided
+
+- **`elizaos tee phala cvms delete [app-id]`** - Delete a CVM
+
+  - Options:
+    - `-f, --force` - Skip confirmation prompt
+
+- **`elizaos tee phala cvms upgrade [app-id]`** - Upgrade a CVM to a new version
+
+  - Options:
+    - `-c, --compose <compose>` - Path to new Docker Compose file
+    - `--env-file <envFile>` - Path to environment file
+    - `--debug` - Enable debug mode
+
+- **`elizaos tee phala cvms resize [app-id]`** - Resize resources for a CVM
+
+  - Options:
+    - `-v, --vcpu <vcpu>` - Number of virtual CPUs
+    - `-m, --memory <memory>` - Memory size in MB
+    - `-d, --disk-size <diskSize>` - Disk size in GB
+    - `-r, --allow-restart <allowRestart>` - Allow restart of the CVM if needed
+    - `-y, --yes` - Automatically confirm the resize operation
+
+- **`elizaos tee phala cvms attestation [app-id]`** - Get attestation information for a CVM
+  - Provides cryptographic proof that your application is running in a secure TEE
+  - Interactive selection if app-id not provided
+
+##### Docker Management (`elizaos tee phala docker`)
+
+- **`elizaos tee phala docker login`** - Login to Docker Hub
+
+  - Configure Docker Hub credentials for pushing images
+
+- **`elizaos tee phala docker build`** - Build a Docker image
+
+  - Options:
+    - `--image <image>` - Docker image name
+    - `--tag <tag>` - Tag for the Docker image
+
+- **`elizaos tee phala docker push`** - Push a Docker image to Docker Hub
+
+  - Options:
+    - `--image <image>` - Docker image name
+    - `--tag <tag>` - Tag to push
+
+- **`elizaos tee phala docker generate`** - Generate a Docker Compose file
+  - Options:
+    - `-i, --image <imageName>` - Docker image name to use in the compose file
+    - `-e, --env-file <envFile>` - Path to environment variables file
+    - `-o, --output <output>` - Output path for generated docker-compose.yml
+    - `--template <template>` - Template to use for the generated docker-compose.yml
+
+##### TEE Simulator (`elizaos tee phala simulator`)
+
+- **`elizaos tee phala simulator start`** - Start the TEE simulator
+
+  - Options:
+    - `-i, --image <image>` - Simulator image to use
+    - `-p, --port <port>` - Simulator port (default: 8090) (default: "8090")
+    - `-t, --type <type>` - Simulator type (docker, native) (default: "docker")
+
+- **`elizaos tee phala simulator stop`** - Stop the TEE simulator
+  - Stops the running TEE simulator container
+
+##### Getting Started
+
+1. **Sign up for Phala Cloud**:
+
+   ```bash
+   elizaos tee phala free
+   # Or visit https://cloud.phala.network to create an account
+   ```
+
+2. **Authenticate**:
+
+   ```bash
+   elizaos tee phala auth login <your-api-key>
+   elizaos tee phala auth status
+   ```
+
+3. **Deploy your first Eliza Agent**:
+
+   ```bash
+   # Create a TEE project starter template
+   elizaos create tee-agent --tee
+
+   # cd into directory and authenticate your Phala Cloud API Key
+   cd tee-agent
+   elizaos tee phala auth login
+
+   # Log into Docker and ensure docker is running
+   elizaos tee phala docker build
+
+   # Publish the Docker image you built
+   elizaos tee phala docker push
+
+   # Generate a Docker Compose file or update the image in the existing docker compose file
+   elizaos tee phala docker generate --template eliza
+
+   # Create and deploy a CVM
+   elizaos tee phala cvms create --name elizaos -c <docker-compose file> -e <path to .env>
+
+   # Check deployment status
+   elizaos tee phala cvms list
+
+   # Upgrade existing deployment
+   elizaos tee phala cvms upgrade -c <docker-compose file> -e <path to .env (optional)>
+   ```
+
+4. **Verify TEE attestation**:
+
+   ```bash
+   elizaos tee phala cvms attestation <app-id>
+   ```
+
+##### Private Registry Support
+
+For private Docker images, set these environment variables before deployment and add them to your docker-compose file:
+
+**DockerHub**:
+
+- `DSTACK_DOCKER_USERNAME` - Your DockerHub username
+- `DSTACK_DOCKER_PASSWORD` - Your DockerHub password or access token
+- `DSTACK_DOCKER_REGISTRY` - Registry URL (optional, defaults to DockerHub)
+
+**AWS ECR**:
+
+- `DSTACK_AWS_ACCESS_KEY_ID` - AWS access key
+- `DSTACK_AWS_SECRET_ACCESS_KEY` - AWS secret key
+- `DSTACK_AWS_REGION` - AWS region
+- `DSTACK_AWS_ECR_REGISTRY` - Full ECR registry URL
+
+##### Additional Resources
+
+- **Command Help**: `elizaos tee phala help` or `elizaos tee phala <command> --help`
+- **Official Documentation**: [Phala Cloud Docs](https://docs.phala.network/phala-cloud)
+- **Dashboard**: [Phala Cloud Dashboard](https://cloud.phala.network)
+- **NPM Package**: [phala on npm](https://www.npmjs.com/package/phala)
+- **Support**: [Phala Network Discord](https://discord.gg/phala-network)
+
+All commands support the full range of options available in the official Phala CLI. For the most current command reference, run `npx phala help`.
 
 ### Updates
 
@@ -266,15 +489,13 @@ Manage environment variables and secrets.
   - `interactive`: Start interactive environment variable manager
     - Options: `-y, --yes`
 
-### Publishing
+### Process Management
 
-#### `elizaos publish`
+#### `elizaos stop`
 
-Publishes the current project or plugin.
+Stop all running ElizaOS agents running locally.
 
-- **Options:**
-  - `--dry-run`: Test run without publishing
-  - `--registry <repo>`: Specify target registry (default: 'elizaOS/registry')
+This command uses `pkill` to terminate all ElizaOS processes and does not accept any options.
 
 ## Development Guide
 
@@ -380,22 +601,47 @@ Plugins extend the functionality of ElizaOS agents by providing additional capab
 5. **Test your plugin**:
 
    ```bash
-   bun run test
+   # Run tests during development
+   elizaos test
    # Or with the CLI directly:
-   elizaos test --plugin
+   elizaos test
+
+   # Test specific components
+   elizaos test component
+
+   # Test end-to-end functionality
+   elizaos test e2e
    ```
 
 6. **Publish your plugin**:
 
    ```bash
+   # Login to npm first
+   npm login
+
+   # Test your plugin thoroughly
+   elizaos test
+
    # Test publishing process
-   elizaos plugins publish --test
+   elizaos publish --test
 
-   # Publish to registry
-   elizaos plugins publish
+   # Publish to npm + GitHub + registry (recommended)
+   elizaos publish
+   ```
+
+7. **Continuous development workflow**:
+
+   ```bash
+   # Make changes to your plugin
+   elizaos dev  # Test locally
 
-   # Or publish to npm
-   elizaos plugins publish --npm
+   # Test your changes
+   elizaos test
+
+   # Update version and publish updates
+   npm version patch  # or minor/major
+   npm publish
+   git push origin main && git push --tags
    ```
 
 ### Developing Projects (Agents)
@@ -451,31 +697,48 @@ Projects contain agent configurations and code for building agent-based applicat
 4. **Add plugins to your project**:
 
    ```bash
-   elizaos project add-plugin @elizaos/plugin-openai
+   elizaos plugins add @elizaos/plugin-openai
    ```
 
 5. **Run your project in development mode**:
 
    ```bash
-   bun run dev
-   # Or with the CLI directly:
    elizaos dev
    ```
 
 6. **Build and start your project**:
 
    ```bash
-   bun run build
-   bun run start
-   # Or with the CLI directly:
    elizaos start
    ```
 
 7. **Test your project**:
+
    ```bash
-   bun run test
-   # Or with the CLI directly:
+   # Run all tests
+   elizaos test
+
+   # Run component tests only
+   elizaos test component
+
+   # Run e2e tests only
+   elizaos test e2e
+
+   # Test with specific options
+   elizaos test --port 4000 --name specific-test
+   ```
+
+8. **Development workflow**:
+
+   ```bash
+   # Make changes to your project
+   elizaos dev  # Development mode with hot-reload
+
+   # Test your changes
    elizaos test
+
+   # Build and start in production mode
+   elizaos start
    ```
 
 ## Contributing