Repository: elizaOS/eliza
Pull request #4493: docs: update docs to prefer direct usage instead of npx
Author: login: wtfsayo
Created: 2025-05-08T08:57:29Z | Merged: 2025-05-08T14:11:28Z

@coderabbitai review

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **Documentation**
  - Updated all CLI usage examples and instructions to use the simplified command format (`elizaos`) instead of `npx @elizaos/cli@beta`.
  - Streamlined installation and help commands in documentation to reflect the new usage.
  - Revised update instructions and command outputs for clarity and consistency with the new CLI invocation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->


Diff:
diff --git a/packages/cli/README.md b/packages/cli/README.md
index 6b0820b86d02c..a5f527ca363aa 100644
--- a/packages/cli/README.md
+++ b/packages/cli/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
+bun install -g @elizaos/cli@beta
 ```
 
 ### Alternative usage with npx
diff --git a/packages/cli/src/commands/publish.ts b/packages/cli/src/commands/publish.ts
index 480b9434f6ef0..a715834ffba53 100644
--- a/packages/cli/src/commands/publish.ts
+++ b/packages/cli/src/commands/publish.ts
@@ -86,7 +86,7 @@ async function checkCliVersion() {
       console.warn(
         `You are using CLI version ${currentVersion}, but the latest version is ${latestVersion} (published ${new Date(timeData[latestVersion]).toLocaleDateString()})`
       );
-      console.info(`Run 'npx @elizaos/cli@beta update' to update to the latest version`);
+      console.info(`Run 'elizaos update' to update to the latest version`);
 
       const { update } = await prompts({
         type: 'confirm',
diff --git a/packages/cli/src/utils/display-banner.ts b/packages/cli/src/utils/display-banner.ts
index 1933b557e6908..3bd870e4cc81b 100644
--- a/packages/cli/src/utils/display-banner.ts
+++ b/packages/cli/src/utils/display-banner.ts
@@ -80,7 +80,7 @@ async function checkForCliUpdate(currentVersion: string) {
     console.log(
       `\x1b[33m\nA new version of elizaOS CLI is available: ${latestVersion} (current: ${currentVersion})\x1b[0m`
     );
-    console.log(`\x1b[32mUpdate with: npx @elizaos/cli@beta update\x1b[0m\n`);
+    console.log(`\x1b[32mUpdate with: elizaos update\x1b[0m\n`);
   } catch {
     /* silent: update check failure must not block banner */
   }
diff --git a/packages/docs/docs/cli/overview.md b/packages/docs/docs/cli/overview.md
index 1f378c5f2ee16..e8fed55544007 100644
--- a/packages/docs/docs/cli/overview.md
+++ b/packages/docs/docs/cli/overview.md
@@ -21,7 +21,7 @@ npm install -g @elizaos/cli@beta
 Or use it directly with npx:
 
 ```bash
-npx @elizaos/cli@beta [command]
+elizaos [command]
 ```
 
 ## Available Commands
diff --git a/packages/docs/docs/cli/test.md b/packages/docs/docs/cli/test.md
index b202376213306..ac38bba63351b 100644
--- a/packages/docs/docs/cli/test.md
+++ b/packages/docs/docs/cli/test.md
@@ -13,7 +13,7 @@ The `test` command allows you to run tests for your ElizaOS projects, plugins, a
 ## Usage
 
 ```bash
-npx @elizaos/cli@beta test [options]
+elizaos test [options]
 ```
 
 ## Options
@@ -77,7 +77,7 @@ Run all tests in the current project:
 cd my-agent-project
 
 # Run all tests
-npx @elizaos/cli@beta test
+elizaos test
 ```
 
 ### Running Specific Tests
@@ -86,13 +86,13 @@ Filter tests by plugin or skip certain test types:
 
 ```bash
 # Run only tests for 'my-custom-plugin'
-npx @elizaos/cli@beta test -pl my-custom-plugin
+elizaos test -pl my-custom-plugin
 
 # Run project tests but skip all plugin tests
-npx @elizaos/cli@beta test -sp
+elizaos test -sp
 
 # Run plugin tests but skip all project tests
-npx @elizaos/cli@beta test -spt
+elizaos test -spt
 ```
 
 ## Test Output
@@ -227,14 +227,14 @@ test('check_knowledge_retrieval', async (runtime) => {
 
 ```bash
 # Run all tests
-npx @elizaos/cli@beta test
+elizaos test
 ```
 
 ### CI/CD Integration
 
 ```bash
 # Run tests in CI environment
-npx @elizaos/cli@beta test
+elizaos test
 ```
 
 ## Troubleshooting
@@ -245,10 +245,10 @@ If tests aren't being discovered:
 
 ```bash
 # Check test discovery with verbose logging
-npx @elizaos/cli@beta test --dry-run --verbose
+elizaos test --dry-run --verbose
 
 # Try specifying the test file directly
-npx @elizaos/cli@beta test --file src/tests/main.test.ts
+elizaos test --file src/tests/main.test.ts
 ```
 
 ### Tests timing out
@@ -265,7 +265,7 @@ If TypeScript compilation is failing:
 
 ```bash
 # Build the project first
-npx @elizaos/cli@beta project build
+elizaos project build
 
 # Then run tests without recompilation (not applicable)
 ```
diff --git a/packages/docs/docs/core/plugins.md b/packages/docs/docs/core/plugins.md
index 94a83d1160390..6c031ead6af49 100644
--- a/packages/docs/docs/core/plugins.md
+++ b/packages/docs/docs/core/plugins.md
@@ -57,7 +57,7 @@ You can create a new ElizaOS plugin using the CLI:
 npm create eliza@beta
 
 # Or using npx
-npx @elizaos/cli@beta create
+npx create-eliza
 ```
 
 When prompted, select "Plugin" as the type to create. The CLI will guide you through the setup process, creating a plugin with the proper structure and dependencies.
@@ -92,13 +92,13 @@ There are several ways to add plugins to your ElizaOS project:
   <TabItem value="cli" label="Via CLI Commands">
     ```bash
     # Add a plugin
-    npx @elizaos/cli@beta plugins add @elizaos/plugin-twitter
+    elizaos plugins add @elizaos/plugin-twitter
 
     # Remove a plugin
-    npx @elizaos/cli@beta plugins remove @elizaos/plugin-twitter
+    elizaos plugins remove @elizaos/plugin-twitter
 
     # List available plugins
-    npx @elizaos/cli@beta plugins list
+    elizaos plugins list
     ```
 
   </TabItem>
@@ -164,7 +164,7 @@ npm run build
 
     ```bash
     # Publish to GitHub
-    npx @elizaos/cli@beta publish
+    elizaos publish
     ```
 
     This will:
@@ -183,7 +183,7 @@ npm run build
 
     ```bash
     # Publish to npm
-    npx @elizaos/cli@beta publish --npm
+    elizaos publish --npm
     ```
 
     This allows users to install your plugin using standard npm commands:
@@ -206,7 +206,7 @@ npm run build
 
     ```bash
     # Test the publish process
-    npx @elizaos/cli@beta publish --test
+    elizaos publish --test
     ```
 
     This runs through all the packaging and validation steps without actually publishing anything.
@@ -226,19 +226,19 @@ npm run build
 
     ```bash
     # Specify platform compatibility
-    npx @elizaos/cli@beta publish --platform node
+    elizaos publish --platform node
 
     # Set custom version number
-    npx @elizaos/cli@beta publish --version 1.2.3
+    elizaos publish --version 1.2.3
 
     # Provide a custom registry URL
-    npx @elizaos/cli@beta publish --registry https://custom-registry.com
+    elizaos publish --registry https://custom-registry.com
 
     # Publish with public access
-    npx @elizaos/cli@beta publish --access public
+    elizaos publish --access public
     ```
 
-    These options give you fine-grained control over how and where your plugin is published. Refer to `npx @elizaos/cli@beta publish --help` for a complete list of options.
+    These options give you fine-grained control over how and where your plugin is published. Refer to `elizaos publish --help` for a complete list of options.
 
   </TabItem>
 </Tabs>
@@ -586,10 +586,10 @@ During development, you can test your plugin locally:
 
 ```bash
 # Start with your plugin
-npx @elizaos/cli@beta start --plugins=./path/to/plugin
+elizaos start --plugins=./path/to/plugin
 
 # Or with a specific character
-npx @elizaos/cli@beta start --character=./characters/test.character.json --plugins=./path/to/plugin
+elizaos start --character=./characters/test.character.json --plugins=./path/to/plugin
 ```
 
 ### Distribution & PR Requirements
@@ -628,7 +628,7 @@ Plugin dependencies are managed through your project's `package.json`. You can a
 Yes, you can use the `--plugins` flag with the `start` command to include local plugins during development:
 
 ```bash
-npx @elizaos/cli@beta start --plugins=./path/to/plugin
+elizaos start --plugins=./path/to/plugin
 ```
 
 ### What's the difference between Actions and Services?
diff --git a/packages/docs/docs/core/project.md b/packages/docs/docs/core/project.md
index 2fa7e87537e3f..198dc2cf0ec11 100644
--- a/packages/docs/docs/core/project.md
+++ b/packages/docs/docs/core/project.md
@@ -326,7 +326,7 @@ Each agent operates independently but can share the same database and resources.
 After configuring your project, you can run it using:
 
 ```bash
-npx @elizaos/cli@beta start
+elizaos start
 ```
 
 This will start your agents according to your project configuration.
diff --git a/packages/docs/docs/faq.md b/packages/docs/docs/faq.md
index 97901eb8868f2..2ca5df2d830a8 100644
--- a/packages/docs/docs/faq.md
+++ b/packages/docs/docs/faq.md
@@ -72,7 +72,7 @@ bun build
 ## Running Multiple Agents
 
 ```bash
-npx @elizaos/cli@beta start --characters="characters/agent1.json,characters/agent2.json"
+elizaos start --characters="characters/agent1.json,characters/agent2.json"
 ```
 
 2. Create separate projects for each agent with their own configurations
@@ -211,7 +211,7 @@ Check your database for null memory entries and ensure proper content formatting
 Using the CLI:
 
 ```bash
-npx @elizaos/cli@beta agent reset-memory
+elizaos agent reset-memory
 ```
 
 Or manually:
@@ -234,7 +234,7 @@ Or manually:
 Using the CLI:
 
 ```bash
-npx @elizaos/cli@beta project add-plugin @elizaos/plugin-name
+elizaos project add-plugin @elizaos/plugin-name
 ```
 
 Or manually:
diff --git a/packages/docs/docs/intro.md b/packages/docs/docs/intro.md
index 14064d5be9959..88df1fcf1189c 100644
--- a/packages/docs/docs/intro.md
+++ b/packages/docs/docs/intro.md
@@ -91,13 +91,13 @@ Then visit https://localhost:3000 to interact with your agent through a web inte
 
 ```bash
 # Create a new project through interactive setup
-npx @elizaos/cli@beta create # will be simpler after beta
+elizaos create # will be simpler after beta
 
 # Navigate to your project directory
 cd my-project-name
 
 # Start your project
-npx @elizaos/cli@beta start
+elizaos start
 ```
 
   </TabItem>
diff --git a/packages/docs/static/llms-community.txt b/packages/docs/static/llms-community.txt
index d277f2e6e327f..d8001a6edd630 100644
--- a/packages/docs/static/llms-community.txt
+++ b/packages/docs/static/llms-community.txt
@@ -3943,7 +3943,7 @@ Each agent operates independently but can share the same database and resources.
 After configuring your project, you can run it using:
 
 ```bash
-npx @elizaos/cli@beta start
+elizaos start
 ```
 
 This will start your agents according to your project configuration.
@@ -5653,13 +5653,13 @@ Then visit https://localhost:3000 to interact with your agent through a web inte
 
 ```bash
 # Create a new project through interactive setup
-npx @elizaos/cli@beta create # will be simpler after beta
+elizaos create # will be simpler after beta
 
 # Navigate to your project directory
 cd my-project-name
 
 # Start your project
-npx @elizaos/cli@beta start
+elizaos start
 ```
 
   </TabItem>
@@ -5768,7 +5768,7 @@ elizaos start
 
 ```bash
 # Use directly with npx
-npx @elizaos/cli@beta start
+elizaos start
 ```
 
   </TabItem>
@@ -11924,13 +11924,13 @@ There are several ways to add plugins to your ElizaOS project:
   <TabItem value="cli" label="Via CLI Commands">
     ```bash
     # Add a plugin
-    npx @elizaos/cli@beta plugins add @elizaos/plugin-twitter
+    elizaos plugins add @elizaos/plugin-twitter
 
     # Remove a plugin
-    npx @elizaos/cli@beta plugins remove @elizaos/plugin-twitter
+    elizaos plugins remove @elizaos/plugin-twitter
 
     # List available plugins
-    npx @elizaos/cli@beta plugins list
+    elizaos plugins list
     ```
 
   </TabItem>
@@ -11996,7 +11996,7 @@ npm run build
 
     ```bash
     # Publish to GitHub
-    npx @elizaos/cli@beta publish
+    elizaos publish
     ```
 
     This will:
@@ -12015,7 +12015,7 @@ npm run build
 
     ```bash
     # Publish to npm
-    npx @elizaos/cli@beta publish --npm
+    elizaos publish --npm
     ```
 
     This allows users to install your plugin using standard npm commands:
@@ -12038,7 +12038,7 @@ npm run build
 
     ```bash
     # Test the publish process
-    npx @elizaos/cli@beta publish --test
+    elizaos publish --test
     ```
 
     This runs through all the packaging and validation steps without actually publishing anything.
@@ -12058,19 +12058,19 @@ npm run build
 
     ```bash
     # Specify platform compatibility
-    npx @elizaos/cli@beta publish --platform node
+    elizaos publish --platform node
 
     # Set custom version number
-    npx @elizaos/cli@beta publish --version 1.2.3
+    elizaos publish --version 1.2.3
 
     # Provide a custom registry URL
-    npx @elizaos/cli@beta publish --registry https://custom-registry.com
+    elizaos publish --registry https://custom-registry.com
 
     # Publish with public access
-    npx @elizaos/cli@beta publish --access public
+    elizaos publish --access public
     ```
 
-    These options give you fine-grained control over how and where your plugin is published. Refer to `npx @elizaos/cli@beta publish --help` for a complete list of options.
+    These options give you fine-grained control over how and where your plugin is published. Refer to `elizaos publish --help` for a complete list of options.
 
   </TabItem>
 </Tabs>
@@ -12418,10 +12418,10 @@ During development, you can test your plugin locally:
 
 ```bash
 # Start with your plugin
-npx @elizaos/cli@beta start --plugin=./path/to/plugin
+elizaos start --plugin=./path/to/plugin
 
 # Or with a specific character
-npx @elizaos/cli@beta start --character=./characters/test.character.json --plugin=./path/to/plugin
+elizaos start --character=./characters/test.character.json --plugin=./path/to/plugin
 ```
 
 ### Distribution & PR Requirements
@@ -12460,7 +12460,7 @@ Plugin dependencies are managed through your project's `package.json`. You can a
 Yes, you can use the `--plugin` flag with the `start` command to include local plugins during development:
 
 ```bash
-npx @elizaos/cli@beta start --plugin=./path/to/plugin
+elizaos start --plugin=./path/to/plugin
 ```
 
 ### What's the difference between Actions and Services?
diff --git a/packages/docs/static/llms-full.txt b/packages/docs/static/llms-full.txt
index 0eb9d45f0ce1a..c59fbb9fdbab9 100644
--- a/packages/docs/static/llms-full.txt
+++ b/packages/docs/static/llms-full.txt
@@ -3379,13 +3379,13 @@ There are several ways to add plugins to your ElizaOS project:
   <TabItem value="cli" label="Via CLI Commands">
     ```bash
     # Add a plugin
-    npx @elizaos/cli@beta plugins add @elizaos/plugin-twitter
+    elizaos plugins add @elizaos/plugin-twitter
 
     # Remove a plugin
-    npx @elizaos/cli@beta plugins remove @elizaos/plugin-twitter
+    elizaos plugins remove @elizaos/plugin-twitter
 
     # List available plugins
-    npx @elizaos/cli@beta plugins list
+    elizaos plugins list
     ```
 
   </TabItem>
@@ -3451,7 +3451,7 @@ npm run build
 
     ```bash
     # Publish to GitHub
-    npx @elizaos/cli@beta publish
+    elizaos publish
     ```
 
     This will:
@@ -3470,7 +3470,7 @@ npm run build
 
     ```bash
     # Publish to npm
-    npx @elizaos/cli@beta publish --npm
+    elizaos publish --npm
     ```
 
     This allows users to install your plugin using standard npm commands:
@@ -3493,7 +3493,7 @@ npm run build
 
     ```bash
     # Test the publish process
-    npx @elizaos/cli@beta publish --test
+    elizaos publish --test
     ```
 
     This runs through all the packaging and validation steps without actually publishing anything.
@@ -3513,19 +3513,19 @@ npm run build
 
     ```bash
     # Specify platform compatibility
-    npx @elizaos/cli@beta publish --platform node
+    elizaos publish --platform node
 
     # Set custom version number
-    npx @elizaos/cli@beta publish --version 1.2.3
+    elizaos publish --version 1.2.3
 
     # Provide a custom registry URL
-    npx @elizaos/cli@beta publish --registry https://custom-registry.com
+    elizaos publish --registry https://custom-registry.com
 
     # Publish with public access
-    npx @elizaos/cli@beta publish --access public
+    elizaos publish --access public
     ```
 
-    These options give you fine-grained control over how and where your plugin is published. Refer to `npx @elizaos/cli@beta publish --help` for a complete list of options.
+    These options give you fine-grained control over how and where your plugin is published. Refer to `elizaos publish --help` for a complete list of options.
 
   </TabItem>
 </Tabs>
@@ -3873,10 +3873,10 @@ During development, you can test your plugin locally:
 
 ```bash
 # Start with your plugin
-npx @elizaos/cli@beta start --plugin=./path/to/plugin
+elizaos start --plugin=./path/to/plugin
 
 # Or with a specific character
-npx @elizaos/cli@beta start --character=./characters/test.character.json --plugin=./path/to/plugin
+elizaos start --character=./characters/test.character.json --plugin=./path/to/plugin
 ```
 
 ### Distribution & PR Requirements
@@ -3915,7 +3915,7 @@ Plugin dependencies are managed through your project's `package.json`. You can a
 Yes, you can use the `--plugin` flag with the `start` command to include local plugins during development:
 
 ```bash
-npx @elizaos/cli@beta start --plugin=./path/to/plugin
+elizaos start --plugin=./path/to/plugin
 ```
 
 ### What's the difference between Actions and Services?
@@ -4255,7 +4255,7 @@ Each agent operates independently but can share the same database and resources.
 After configuring your project, you can run it using:
 
 ```bash
-npx @elizaos/cli@beta start
+elizaos start
 ```
 
 This will start your agents according to your project configuration.
@@ -8034,7 +8034,7 @@ elizaos start
 
 ```bash
 # Use directly with npx
-npx @elizaos/cli@beta start
+elizaos start
 ```
 
   </TabItem>


Reviews:
user: login: coderabbitai[bot]
body: **Actionable comments posted: 3**

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 300fc45012ee199eecda3a71aeb85124719ddb6c and 8b0a3f8c949b455bd4fb2e9d22cf9dae6f0788bc.

</details>

<details>
<summary>📒 Files selected for processing (11)</summary>

* `packages/cli/README.md` (2 hunks)
* `packages/cli/src/commands/publish.ts` (1 hunks)
* `packages/cli/src/utils/display-banner.ts` (1 hunks)
* `packages/docs/docs/cli/overview.md` (1 hunks)
* `packages/docs/docs/cli/test.md` (6 hunks)
* `packages/docs/docs/core/plugins.md` (8 hunks)
* `packages/docs/docs/core/project.md` (1 hunks)
* `packages/docs/docs/faq.md` (3 hunks)
* `packages/docs/docs/intro.md` (1 hunks)
* `packages/docs/static/llms-community.txt` (10 hunks)
* `packages/docs/static/llms-full.txt` (9 hunks)

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms (4)</summary>

* GitHub Check: integration-tests
* GitHub Check: test
* GitHub Check: integration-tests
* GitHub Check: test

</details>

<details>
<summary>🔇 Additional comments (19)</summary><blockquote>

<details>
<summary>packages/cli/src/commands/publish.ts (1)</summary>

`89-89`: **Update CLI update prompt to use `elizaos update`**  
This aligns the user-facing message with the new direct invocation pattern.

</details>
<details>
<summary>packages/docs/docs/cli/overview.md (1)</summary>

`24-24`: **Prefer direct CLI usage in example**  
The snippet now correctly shows `elizaos [command]` instead of the old `npx` prefix.

</details>
<details>
<summary>packages/cli/src/utils/display-banner.ts (1)</summary>

`83-83`: **Simplify banner update instruction**  
The banner message now tells users to run `elizaos update`, matching the streamlined CLI usage.

</details>
<details>
<summary>packages/docs/docs/core/project.md (1)</summary>

`329-329`: **Streamline project run command**  
The example correctly switches from `npx @elizaos/cli@beta start` to `elizaos start`.

</details>
<details>
<summary>packages/docs/docs/intro.md (2)</summary>

`94-94`: **Use `elizaos create` in quick-start snippet**  
This change aligns the create command with the preferred direct CLI invocation.

---

`100-100`: **Use `elizaos start` in quick-start snippet**  
The start command example now correctly reflects the simplified CLI usage.

</details>
<details>
<summary>packages/docs/docs/faq.md (2)</summary>

`75-75`: **Consistent direct CLI invocation.**  
The example correctly uses `elizaos start` instead of `npx`.

---

`237-237`: **Correct plugin-add command.**  
The `elizaos project add-plugin` example now omits `npx` as intended.

</details>
<details>
<summary>packages/cli/README.md (1)</summary>

`8-8`: **Installation command is fine.**  
Installing the beta CLI via Bun remains correct.

</details>
<details>
<summary>packages/docs/docs/cli/test.md (1)</summary>

`16-16`: **All direct invocation examples look correct.**  
Every `elizaos test` and `elizaos project build` example properly omits `npx`.  



Also applies to: 80-80, 89-89, 93-93, 95-95, 230-230, 237-237, 248-248, 251-251, 268-268

</details>
<details>
<summary>packages/docs/docs/core/plugins.md (1)</summary>

`167-167`: **Direct invocation examples approved.**  
All `elizaos publish` and `elizaos start` examples correctly omit `npx`.  



Also applies to: 186-186, 209-209, 229-229, 232-232, 235-235, 238-238, 241-241, 589-589, 592-592

</details>
<details>
<summary>packages/docs/static/llms-full.txt (7)</summary>

`8382-8388`: **Command syntax update improves clarity.**

The documentation now uses the direct `elizaos` command structure instead of the longer `npx @elizaos/cli@beta` form for plugin management operations. This change makes commands more concise and easier to use.

---

`8454-8454`: **Simplified publish command.**

Updated GitHub publishing command to use `elizaos publish` for better consistency and ease of use.

---

`8472-8496`: **Publishing commands standardized to direct CLI usage.**

All publishing commands now follow the simplified syntax pattern using direct `elizaos` commands. This makes documentation more readable and commands easier to remember.

---

`8516-8525`: **Additional options syntax aligned with updated CLI pattern.**

Command options for platform compatibility, versioning, registry selection, and access control now use the consistent `elizaos` prefix, maintaining a uniform interface across all command variants.

---

`8528-8528`: **Help command reference updated.**

Reference to help documentation now uses the updated command format (`elizaos publish --help`), ensuring users have the correct syntax for accessing command help.

---

`8876-8876`: **Start command simplified.**

The `start` command now uses the cleaner `elizaos start` syntax instead of the npx invocation, consistent with the CLI update pattern throughout the documentation.

---

`8959-8959`: **Plugin and character specification commands standardized.**

Commands for starting ElizaOS with specific plugins or character files now use the more direct `elizaos` command structure, maintaining consistency with the overall documentation update.



Also applies to: 8879-8879, 8918-8918

</details>
<details>
<summary>packages/docs/static/llms-community.txt (1)</summary>

`1946-1946`: **CLI command standardization provides cleaner interface.**

Good update. Switching from `npx @elizaos/cli@beta start` to `elizaos start` provides a more intuitive, streamlined developer experience by assuming proper CLI installation rather than requiring explicit package execution commands.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-08T09:34:41Z
user: login: wtfsayo
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-08T09:36:44Z
user: login: coderabbitai[bot]
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-08T09:37:37Z
user: login: ChristopherTrimboli
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-08T14:07:52Z
user: login: copilot-pull-request-reviewer[bot]
body: ## Pull Request Overview

This PR updates the documentation to streamline CLI usage by replacing the legacy "npx @elizaos/cli@beta" commands with the new "elizaos" command format. Key changes include updating command examples in various docs files, revising update instructions in CLI output messages, and modifying installation instructions in the README.

### Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

<details>
<summary>Show a summary per file</summary>

| File                                         | Description                                                                                   |
|----------------------------------------------|-----------------------------------------------------------------------------------------------|
| packages/docs/static/llms-full.txt           | Replaced legacy CLI commands with the new "elizaos" command.                                  |
| packages/docs/static/llms-community.txt      | Updated CLI usage examples to simplify command usage.                                         |
| packages/docs/docs/intro.md                  | Changed legacy CLI command examples to the new "elizaos" format.                              |
| packages/docs/docs/faq.md                    | Revised multiple CLI command examples for consistency.                                        |
| packages/docs/docs/core/project.md           | Updated start command example to reflect new command usage.                                   |
| packages/docs/docs/core/plugins.md           | Updated various plugin-related CLI commands; note the create command now uses "npx create-eliza". |
| packages/docs/docs/cli/test.md               | Updated test command examples to the new "elizaos" syntax.                                    |
| packages/docs/docs/cli/overview.md           | Changed the usage example from legacy format to "elizaos".                                    |
| packages/cli/src/utils/display-banner.ts     | Modified the update command output text to instruct users to run "elizaos update".              |
| packages/cli/src/commands/publish.ts         | Revised update instruction message to match the new command syntax.                           |
| packages/cli/README.md                       | Adjusted installation command to reference the beta version.                                  |
</details>





state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-08T14:08:30Z

Review comments:
diff_hunk: @@ -20,7 +20,7 @@ This is useful for trying out commands without installing the CLI globally.
 
 ## Commands
 
-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`.
+Below is a comprehensive reference for all ElizaOS CLI commands, including their options, arguments, and subcommands. For the most up-to-date usage, run `npx @elizaos/cli@beta [command] --help`.
path: packages/cli/README.md
user: login: coderabbitai[bot]
body: _🛠️ Refactor suggestion_

**Prefer direct help invocation.**  
The help recommendation still uses `npx`. It should be updated to use direct invocation:

```diff
- For the most up-to-date usage, run `npx @elizaos/cli@beta [command] --help`.
+ For the most up-to-date usage, run `elizaos [command] --help`.
```  



<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

`````suggestion
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`.
`````

</details>

<!-- suggestion_end -->

<details>
<summary>🤖 Prompt for AI Agents (early access)</summary>

```
In packages/cli/README.md at line 23, update the help command usage from using
`npx @elizaos/cli@beta [command] --help` to direct invocation of the CLI, such
as `elizaos [command] --help`. Replace the example to reflect direct CLI usage
instead of using npx.
```

</details>

<!-- This is an auto-generated comment by CodeRabbit -->
created_at: 2025-05-08T09:34:40Z
author_association: CONTRIBUTOR
diff_hunk: @@ -92,13 +92,13 @@ There are several ways to add plugins to your ElizaOS project:
   <TabItem value="cli" label="Via CLI Commands">
     ```bash
     # Add a plugin
-    npx @elizaos/cli@beta plugins add @elizaos/plugin-twitter
+    elizaos plugins add @elizaos/plugin-twitter
 
     # Remove a plugin
-    npx @elizaos/cli@beta plugins remove @elizaos/plugin-twitter
+    elizaos plugins remove @elizaos/plugin-twitter
 
     # List available plugins
-    npx @elizaos/cli@beta plugins list
+    elizaos plugins list
path: packages/docs/docs/core/plugins.md
user: login: coderabbitai[bot]
body: _⚠️ Potential issue_

**Fix typo in CLI subcommand.**  
The docs use `elizaos plugins` (plural), but the correct command is singular `plugin`:

```diff
- elizaos plugins add @elizaos/plugin-twitter
+ elizaos plugin add @elizaos/plugin-twitter

- elizaos plugins remove @elizaos/plugin-twitter
+ elizaos plugin remove @elizaos/plugin-twitter

- elizaos plugins list
+ elizaos plugin list
```



<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

`````suggestion
    elizaos plugin add @elizaos/plugin-twitter

    # Remove a plugin
    elizaos plugin remove @elizaos/plugin-twitter

    # List available plugins
    elizaos plugin list
`````

</details>

<!-- suggestion_end -->

<details>
<summary>🤖 Prompt for AI Agents (early access)</summary>

```
In packages/docs/docs/core/plugins.md around lines 95 to 101, the CLI
subcommands incorrectly use the plural form "plugins" instead of the correct
singular "plugin". Update all instances of "elizaos plugins" to "elizaos plugin"
to reflect the accurate command usage in the documentation.
```

</details>

<!-- This is an auto-generated reply by CodeRabbit -->
created_at: 2025-05-08T09:34:40Z
author_association: CONTRIBUTOR
diff_hunk: @@ -57,7 +57,7 @@
 npm create eliza@beta
 
 # Or using npx
-npx @elizaos/cli@beta create
+npx create-eliza
path: packages/docs/docs/core/plugins.md
user: login: coderabbitai[bot]
body: _🛠️ Refactor suggestion_

**Remove legacy `npx` usage.**  
The alternative creation step still shows `npx create-eliza`. Since we now prefer direct usage, remove this block or replace with the `npm create eliza` form:

```diff
- # Or using npx
- npx create-eliza
```



<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

`````suggestion

`````

</details>

<!-- suggestion_end -->

<details>
<summary>🤖 Prompt for AI Agents (early access)</summary>

```
In packages/docs/docs/core/plugins.md at line 60, replace the legacy usage of
"npx create-eliza" with the preferred modern command "npm create eliza" or
remove the line entirely to reflect the updated recommended usage.
```

</details>

<!-- This is an auto-generated comment by CodeRabbit -->
created_at: 2025-05-08T09:34:40Z
author_association: CONTRIBUTOR
diff_hunk: @@ -92,13 +92,13 @@ There are several ways to add plugins to your ElizaOS project:
   <TabItem value="cli" label="Via CLI Commands">
     ```bash
     # Add a plugin
-    npx @elizaos/cli@beta plugins add @elizaos/plugin-twitter
+    elizaos plugins add @elizaos/plugin-twitter
 
     # Remove a plugin
-    npx @elizaos/cli@beta plugins remove @elizaos/plugin-twitter
+    elizaos plugins remove @elizaos/plugin-twitter
 
     # List available plugins
-    npx @elizaos/cli@beta plugins list
+    elizaos plugins list
path: packages/docs/docs/core/plugins.md
user: login: wtfsayo
body: you're wrong
created_at: 2025-05-08T09:36:44Z
author_association: CONTRIBUTOR
diff_hunk: @@ -92,13 +92,13 @@ There are several ways to add plugins to your ElizaOS project:
   <TabItem value="cli" label="Via CLI Commands">
     ```bash
     # Add a plugin
-    npx @elizaos/cli@beta plugins add @elizaos/plugin-twitter
+    elizaos plugins add @elizaos/plugin-twitter
 
     # Remove a plugin
-    npx @elizaos/cli@beta plugins remove @elizaos/plugin-twitter
+    elizaos plugins remove @elizaos/plugin-twitter
 
     # List available plugins
-    npx @elizaos/cli@beta plugins list
+    elizaos plugins list
path: packages/docs/docs/core/plugins.md
user: login: coderabbitai[bot]
body: <details>
<summary>🧩 Analysis chain</summary>

🏁 Script executed:
```
#!/bin/bash
# Let's first check if there's a plugin/plugins command defined in the CLI code
echo "Searching for CLI command definitions..."
rg -A 3 "plugins.*command" --glob "*.ts" --glob "*.js"

# Also check for singular form
rg -A 3 "plugin.*command" --glob "*.ts" --glob "*.js"

# Let's also look at documentation or examples elsewhere in the codebase
echo "Searching for command usage examples..."
rg "elizaos plugins" --glob "*.md"
rg "elizaos plugin" --glob "*.md"

# Check the CLI command structure files more broadly
echo "Looking for command structure files..."
fd -t f "command" --exec head -n 20 {}
```

Length of output: 16168

---



</details>

@wtfsayo You're absolutely right, and I apologize for my error. After checking the codebase more thoroughly, I can see that the documentation correctly uses the plural form `elizaos plugins` for the add/remove/list commands.

Looking at the code in `packages/cli/src/commands/plugins.ts` and the extensive usage examples throughout the documentation, the plural form is indeed correct.

I see now that there seems to be a pattern where:
- `elizaos plugins` (plural) is used for plugin management: add, remove, list
- `elizaos plugin` (singular) is used for plugin development operations like publishing

Thank you for the correction!

---

<details>
<summary>✏️ Learnings added</summary>

```
Learnt from: wtfsayo
PR: elizaOS/eliza#4493
File: packages/docs/docs/core/plugins.md:95-101
Timestamp: 2025-05-08T09:37:35.784Z
Learning: The ElizaOS CLI uses the plural form "plugins" for plugin management commands (e.g., "elizaos plugins add", "elizaos plugins remove", "elizaos plugins list"), while the singular form "plugin" is used for plugin development operations (e.g., "elizaos plugin publish").
```

> Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).

</details>




<!-- <agentComponentType>chat-answer</agentComponentType> -->

<!-- <rawResChunk><answer><details>
<summary>🧩 Analysis chain</summary>

🏁 Script executed:
```
#!/bin/bash
# Let's first check if there's a plugin/plugins command defined in the CLI code
echo "Searching for CLI command definitions..."
rg -A 3 "plugins.*command" --glob "*.ts" --glob "*.js"

# Also check for singular form
rg -A 3 "plugin.*command" --glob "*.ts" --glob "*.js"

# Let's also look at documentation or examples elsewhere in the codebase
echo "Searching for command usage examples..."
rg "elizaos plugins" --glob "*.md"
rg "elizaos plugin" --glob "*.md"

# Check the CLI command structure files more broadly
echo "Looking for command structure files..."
fd -t f "command" --exec head -n 20 {}
```

Length of output: 16168

---



</details>

@wtfsayo You're absolutely right, and I apologize for my error. After checking the codebase more thoroughly, I can see that the documentation correctly uses the plural form `elizaos plugins` for the add/remove/list commands.

Looking at the code in `packages/cli/src/commands/plugins.ts` and the extensive usage examples throughout the documentation, the plural form is indeed correct.

I see now that there seems to be a pattern where:
- `elizaos plugins` (plural) is used for plugin management: add, remove, list
- `elizaos plugin` (singular) is used for plugin development operations like publishing

Thank you for the correction!

---

<details>
<summary>✏️ Learnings added</summary>

```
Learnt from: wtfsayo
PR: elizaOS/eliza#4493
File: packages/docs/docs/core/plugins.md:95-101
Timestamp: 2025-05-08T09:37:35.784Z
Learning: The ElizaOS CLI uses the plural form "plugins" for plugin management commands (e.g., "elizaos plugins add", "elizaos plugins remove", "elizaos plugins list"), while the singular form "plugin" is used for plugin development operations (e.g., "elizaos plugin publish").
```

> Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).

</details>

</answer></rawResChunk> -->

<!-- This is an auto-generated reply by CodeRabbit -->
created_at: 2025-05-08T09:37:37Z
author_association: CONTRIBUTOR
diff_hunk: @@ -57,7 +57,7 @@ You can create a new ElizaOS plugin using the CLI:
 npm create eliza@beta
 
 # Or using npx
-npx @elizaos/cli@beta create
+npx create-eliza
path: packages/docs/docs/core/plugins.md
user: login: Copilot
body: [nitpick] The create command here uses 'npx create-eliza' which is inconsistent with other examples updated to 'elizaos'. Consider using 'elizaos create' for consistency across the documentation, unless this deviation is intentional.
```suggestion
elizaos create
```
created_at: 2025-05-08T14:08:30Z
author_association: CONTRIBUTOR

PR comments:
user: login: coderabbitai[bot]
created_at: 2025-05-08T08:57:36Z
body: <!-- This is an auto-generated comment: summarize by coderabbit.ai -->
<!-- This is an auto-generated comment: skip review by coderabbit.ai -->

> [!IMPORTANT]
> ## Review skipped
> 
> Auto reviews are disabled on this repository.
> 
> Please check the settings in the CodeRabbit UI or the `.coderabbit.yaml` file in this repository. To trigger a single review, invoke the `@coderabbitai review` command.
> 
> You can disable this status message by setting the `reviews.review_status` to `false` in the CodeRabbit configuration file.

<!-- end of auto-generated comment: skip review by coderabbit.ai -->
<!-- walkthrough_start -->

## Walkthrough

This update standardizes and simplifies ElizaOS CLI usage instructions across documentation and user-facing messages. It replaces explicit `npx @elizaos/cli@beta` invocations with the direct `elizaos` command and updates installation and update instructions to reflect the preferred usage pattern. No underlying logic or exported entities were changed.

## Changes

| File(s)                                                                                  | Change Summary                                                                                                                      |
|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `packages/cli/README.md`                                                                 | Updated installation and help instructions to reference the beta version and use `npx` with version tag only where appropriate.     |
| `packages/cli/src/commands/publish.ts`,<br>`packages/cli/src/utils/display-banner.ts`    | Changed CLI update instruction messages from `npx @elizaos/cli@beta update` to `elizaos update`.                                   |
| `packages/docs/docs/cli/overview.md`                                                     | Simplified CLI usage example from `npx @elizaos/cli@beta [command]` to `elizaos [command]`.                                        |
| `packages/docs/docs/cli/test.md`                                                         | Replaced all `npx @elizaos/cli@beta test` examples with `elizaos test`.                                                            |
| `packages/docs/docs/core/plugins.md`                                                     | Updated all CLI plugin management and publishing commands to use `elizaos` instead of `npx @elizaos/cli@beta`.                     |
| `packages/docs/docs/core/project.md`                                                     | Changed project run command from `npx @elizaos/cli@beta start` to `elizaos start`.                                                 |
| `packages/docs/docs/faq.md`                                                              | Replaced all CLI command examples from `npx @elizaos/cli@beta` to `elizaos`.                                                       |
| `packages/docs/docs/intro.md`                                                            | Updated project creation and start commands to use `elizaos` directly, removing `npx` usage.                                       |
| `packages/docs/static/llms-community.txt`,<br>`packages/docs/static/llms-full.txt`       | Replaced all CLI command examples from `npx @elizaos/cli@beta` to `elizaos` across multiple documentation sections.                |

## Possibly related PRs

- elizaOS/eliza#4381: Also focuses on simplifying CLI command usage by removing the `npx` prefix and using direct `elizaos` invocations in documentation and messages.

## Poem

> A CLI once wrapped in `npx` shell,  
> Now stands alone, and works as well.  
> Commands are clear, the docs are neat,  
> Just type `elizaos`—no extra feat!  
> Simpler calls, less to recall,  
> The CLI stands proud, and answers all.  
> 🚀

<!-- walkthrough_end -->
<!-- internal state start -->


<!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEYDEZyAAUASpETZWaCrKNwSPbABsvkCiQBHbGlcSHFcLzpIACJsblpqD1p8BmQCHn8AM0pIWnh/MUhsRDRSFAxEGjR6fEzIDG4AD2jIAHc0ZAcBZnUaejkw2A9inNbcTJLZfHRkW3rHARyAFiWATgBmcsGPEi94AC80AHkAZQB6XYO0PxJufER1fBcNGCHGWEwy+AwJfC8pZBxBLiDBEba5FKOdjUeD4LDpAosNgYejFb5gvIFULFUoeNi4WCKZBUAk5AmYG5eWTo/jwt4AAwajXpCicKJeADlptU8uI4WhfEpEAwKPBuHysE9ciRcNovMgVPg8ODENxRPBMvAGBCGFCMLKJe9PtI2pQPLx8BJ4Ep+iQpijwf4giFIJkpf4rSRWrl8qI+uhQqSiogckwlFRVOptBpzJYAMJI9idRzMZyuAzuVnI3DIOHg7jeXxO4KVcoMLzYJToH1Ym7O0uZCgsFXYbq9SgAGja40m+C7HQA1jSgyM+GHlJHZToESRPd6gwwPqDpC8AJJYfyquEh/tYNB4FiJfr4UIdRApeBHtrqWAKcMqNRT9AMAcYfCtSK0Uj0IMe+BeusS00V4PAEE8AHJiVuKlyjyBgr3JU8bjnDIUmkZB2jSUUiFIfx6Eweg339RDIATJQbAfdQUAVLBvhFEhswFZD/29RBZEqBjBmoCETSIm4wD/ACmFYdQ0g+UIPikdAvH8ap5EWMhmK9OgXkzMDT3laZs1hcgf3Ex1ZxYrMCOo2kYLQbhuD2eCBEiNohj3A9U3EbVBNaBV/B4fcQ1oTlpkybAKFJPg8mFYoHjhLtsjoAQ0BfLspWE7MMLNVCrRtWl80LQCQhjAx9GMcAoDIGo6n3AhiDIZR/SS9guF4fhhD9SQTQGccI0fLQdAKkwoDgVBUApcrCFIcgSSiWr9S4KhWJTNNIDaxQJ067RdDAQxCtMAxuDigdcUQM5y3gM4bAAUQAQQAEQAWVOjRmFoDgDGiF6DAsSBztXSqxqvBwnBcfg6kXY1EDcN4zqu26dT1A0dNdKUg1OvZDlOUiABlVzaDoiniBDplVdVMnkEcQ0B8FFllSApAoCLJTqIM4wxryX1xVS3iILxBCY75KgFLwYTzJKTMwo1l3oRtm3pARsFoipZR8XQwQAAUuQ57kOvYWXSKWZfKXmFeISAVeRtB1aOpWKbQekXgTChNzuFF0SpLtf1ERMUQmpETLdPhBCnDBhzeZh7mxbgwAq4FhhKMohi8bgseQYGxddJtmEgelVdN5AAG0hZRABdNbY+4LXpkZJojczs29gtmVrlzr2C6L3YS7Z6QPCT0gFT2Ig6Q8Hn5f5w0TJxL45YobAxB0tJphIRorK1dQYKyM0MAYDwg0tykSA6DxanBRnMZ2lnSDy2MPq8GgSWnsJpiDJRy2cAWKjJue7iCqIpQLWytUgdh1H/KDAwXJyAxhetEIwEAwBGGPntLuGtjqIAoAwQ6jdaAHW/nsRAsANA5ieuAt6lhPrfWqlEP6qYAb707tIMGHhD5U0oLTd4ogByQDYIgaOHgfY42BIHOhTMRbUPFqnPWuAJ5T1BMGRht8/C63Lo0SuJtq7wFrpTIEiRS7VgeMwKyoY0HpyroCXGNBravFQMHPImoTQk0oGATIcUaTfB9s5HSTElS4ALKEVoN53HSSvnwooHsKBUhpOomgkBOZEF/olOEYi/iuk5q0M+hCL5X2fjPcED9+bX23K/eeTx/Rf1bNZP++oAE0OAXCEgYDXr5S2rA/aCCzhIJQXgeA8ozihSsmgWQYBYoYDGrgxA+DXrvWIaNUh9ByHzSoUuLutCeGJFFl3A+TMwn93HpPQ07DOE+lVPzWQURWgOWrOQb01MmGDQkHKFQkQXhWD/EqRAztwQ7NxKI8R/pRwZPWcGGk8jFFXGUao646zTH9WQB8GQJBFL+G6eveg3iCRaPgDoyIY40FcAzkooxkdTFcn4MFCJ+AonailJQJsfAly0D2JI/wQ8ojpBHMYjuQwXz8D4BcuGwkdqinPFgEWFiNT/l8kYc+51L7VRvkyt4WSn4SlzHUN+BTP58Ewb/f+4gKkgOqc9WpUCYG7UackVInSUgHSOmcS0lA5z3UenqiBYyvoTPGlMualCgZzIqZmeho8diNDQGirh7oZYB0kXndBNY/QwSRYSZUHMua+AHnzZ+CdllRAlmnNEkiAXGyBRamuW8G5sloPnTR2irLyGxfmyAxbUwF3BQgZAQqrFiQ8IiVgJUojfF+PBbZMpCTiwRm8ehEaMInL4smnwUQE2xR8LILs/hg5WkkUGN+1kqLyJZH69ADoGllC5XmAmDBhV9p0sksZkqckvxlUkUQ2T0l5PfoUtVxSNVlK1UAnVNSIF1OgdtI18CTUHWA00mglQ7UjMdUQ51VVXX2HdfIWZIMFkmphqm7hQZ6TgdwCyCNWxEYm1RvQkW6yfzTDhfzde0lfApF1HbMg69FXgnwz2lIGGRG5sMQgkFYQQiaKDBWvYVj6DVrVmkfjbNUDUPQJkbIYhAS7LnoG3RiAuysZ+OxhV8M+ATwGTSPmfHKhqddO0/xq6QgyHkFZbAUSMBdkQEOSyNJ15BW0PCF0uBZBqhM3GVcZw4yXXKDQIg16XZNmKdIQkJ4XNoJMyZaW7S8irreBaEQhRFg+w3iEdEfl00pU8qmKst7jIOnwOKaeLsXSVE+YFEgCU+CYCQ0Spg+p2ALTtHCVExiAn4d4CQTUCiTJsbPUerzdyxUpIlWk7TJW5XXuY8qj+NRX0/21JqwBRhv0OsgfUwD0gzWmtA0wfwZwbN2cQJBnbTqSHwemR6/LqHISMUNKRll5Gbjwo8IZujgV/BrxNPvBmTMRupv64N9OTJAXiZ45bFksaVSooXiJ0ronDGNuk162T8mcyo6ggyj79EYSSPOzzLs9bSg0lJy/AAFDyRdDFrVdiwbgAAlF2dV2CqcVgu5AGn6QADi6gAASrZd2EW4MwLsdEKzJbBDhthS1xfoFoLyVxtGKvbnZ8r3mQUAl6fEGwa8yLqfIFoIFGkSgpCc0l+wG2Tx7ZdZpMXG42R/tMdNJ5AU55FnEQowNyIhQgxnNR8GVmkACXUIK3iaoG875vBluGEJkjInRL4AFNeEoBTqFkAAbjMsTEdTN8NsX1GgBRIsas72YLSxlsAItEDjYGWVz27eTcvTN6V8e72PwW0+lVK3PBrdKeETblTQE7b/Yak+B3QPHaeCQM7TZ0uaAelBqbsGfr+nu0hz1KGMxvHwwiXWhGriozS36SAUKOuKSE8KqIAxKMOJS+aR5xRyi9tTVxnFsO672FlEFPDjeFooSB/BiiWgYjiv/s4LhlJonFjmgHJn6G2n/AGkGmHmUNgu+LLJkq3mXoaInmSG8NEDYKGjSAAJpKh8APL4Ar4tAhhTxwh5YnhDDp4yyMEYBuJ8A1ZbKBRMRR6e4x7Fbd6oQr4KAYCahEB8GGhSgDyfLTwXpEJXqPpzb3ryo3z7xLYvpD4lIbbapVI/q7b/r7qz7mqHYHT2IBBXYEI3Yuq/SIZkxR5Pa6gvZwxvaRwfZP7UY/YMD0bu6A70xF6Yyg6Gjg7wAKLf75q/6yhAHIqCZI7CYiqh5iZZwY7wHGjY7IF46Uh4zQF66SLMDeDiC6LoCjQ5gM4hi4Aghgi4j6hsKM4uC7j4Sq7c62Y8wyLXAX5iBtz2AMSYAuR/xIGFCoAkTfLoCeRvjehyFbKMoUYn4Mjo6h6YjRryADw7ylR/I5pMixG3iCZqgnqajagmHK6HrwilB5YCGtCpRFZx4sb6LOBSHJQcr8Ca4VAJQYAwQlYaaf79oEiKCKGpJSq5KqG96PqaH5LLbPHqrrYfpj7bYEJT4AYz4gZmGgbfBxLWGjIwa3b2H/S76PYH5JB4GwxHoByWQyg6aMCyTVE64AE0nXAh5dGhBWjXDA6YzuG5FLrWrgjrqLzYikz7xbrG67EMh5ow7mxw7MxwLVKQDrgcTVAuyH5xb1DvhRpiAwQjDggpH3AshzyiB4C3IeA07amJzUkkAsgmQml5G4ba5ZCB70n2AJH36oi7KIFXzkx/7cBQoymZgOB2xKiOySLTEcE0T0CtY0CNChBLruaBJCIAnTZAk3oiHzZglKoQnaHQkj7lJfoGGT4GpInSkommq8wuRnA+DMCIBgBJQyw564KRnr62Fwa4kUL4lOGEnQyuF5gcl+6fZUbfYKy/YMYA7MZskf5aZwxhERFQ5ilZzRFWzCmI5orOnJHo5wHpqZEKZsJFFih2T4bKZBoKgij3DIDXKihPK9EhnS5ryy5U7L6X5E4SgOZ0kGZlEmbU5sKYC4jZh87043DLr1YRJIBs4c487fA6FIAICSI05C64Ci4CBdgNBS5GahAWIAUmS6iVDNjlYKra4mSczwS+Dvk4a5YgS+4eBV6Bq14oG+q7LBnaaP6M4rry5vC8knqhBCkmSnH2D7H34UAM6ZD2kGb2AICZCBjciQCzp8yrFyx8yqqEqsHeKkx34o70IhHnoR7TCXHXGx4yIjhBLJ5ggZ4cHZ5ebPH4bYXTz55wifFKkQFqVHqyBl4V7YwChXwZqJTZI57K47wCl1AjDxnKGzbJlqF97gnPpyWZl6E5mgKkUCHOAeB7A9A9loadkeaRlkWhkQgqkoWKAajyBNaoHhWD6ZnjhZmfqGGIkmFFkHQllahlleAVl2KFh1mcDXbYl2Hb4OHIbLhAKZgpXQiGhgX0hVXmHNKwwoLlmVkBQ+AtXw7YxkYyJeH9m0a+F/aMYBHoyYxjpjlDgv6QBIxn4nCbVUyXiQ4VwznAqSkI7xFLko7LGFD4YmlpHrmIE47IB0U3zcIU52Zgim4/ktGggM7LrojM5AXoja6c6QW/WgW06C4i6tgIWS5ValioVNELk8gAL8ga44Vo2670mvlQkw1m4W6SJW67DlbZj24MZbiBlggu74Yrz+HR7SQ+4LXpCalPWiLrFkxYbbFjmjYYAXFerM03G6UJ76XUiSJGVZ57CmUxIQEWXbhWUfGF4dz6L2VYCl6yjOWdBOko4EgN5N64EuEDXnrt5KGd7AnBWgnaZhUD5Qlvowmj76ET4IkFQGC9SlIbHDQ4k1TuycB+BoCzR4kLTyDtSUSaCrQ9RFRZjqAAD61oiAcdbkdAcdeNa0G0ntAAHAIAAAxoDrCZBZ0MCrBrACBLAACsFdAgtASwmQAgAATCQKsLQA3Q3QwJkC3WgCQAAGyZC50ADsWdOd2o7tntSU8didydhkyktAcdJUGdQAA= -->

<!-- internal state end -->
<!-- tips_start -->

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

<details>
<summary>❤️ Share</summary>

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai)
- [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai)
- [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai)
- [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

</details>

<details>
<summary>🪧 Tips</summary>

### Chat

There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=elizaOS/eliza&utm_content=4493):

- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  - `I pushed a fix in commit <commit_id>, please review it.`
  - `Generate unit testing code for this file.`
  - `Open a follow-up GitHub issue for this discussion.`
- Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples:
  - `@coderabbitai generate unit testing code for this file.`
  -	`@coderabbitai modularize this function.`
- PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.`
  - `@coderabbitai read src/utils.ts and generate unit testing code.`
  - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.`
  - `@coderabbitai help me debug CodeRabbit configuration file.`

### Support

Need help? Create a ticket on our [support page](https://www.coderabbit.ai/contact-us/support) for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

### CodeRabbit Commands (Invoked using PR comments)

- `@coderabbitai pause` to pause the reviews on a PR.
- `@coderabbitai resume` to resume the paused reviews.
- `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
- `@coderabbitai full review` to do a full review from scratch and review all the files again.
- `@coderabbitai summary` to regenerate the summary of the PR.
- `@coderabbitai generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR.
- `@coderabbitai generate sequence diagram` to generate a sequence diagram of the changes in this PR.
- `@coderabbitai resolve` resolve all the CodeRabbit review comments.
- `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository.
- `@coderabbitai help` to get help.

### Other keywords and placeholders

- Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
- Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description.
- Add `@coderabbitai` anywhere in the PR title to generate the title automatically.

### CodeRabbit Configuration File (`.coderabbit.yaml`)

- You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository.
- Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json`

### Documentation and Community

- Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

</details>

<!-- tips_end -->
author_association: CONTRIBUTOR
user: login: wtfsayo
created_at: 2025-05-08T09:30:56Z
body: @coderabbitai review
author_association: CONTRIBUTOR
user: login: coderabbitai[bot]
created_at: 2025-05-08T09:31:12Z
body: <!-- This is an auto-generated reply by CodeRabbit -->
<details>
<summary>✅ Actions performed</summary>

Review triggered.

> Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

</details>
author_association: CONTRIBUTOR