@elizaos/cli 1.0.0-beta.76 → 1.0.0

package/templates/plugin-starter/README.md

@@ -76,33 +76,113 @@ export default new StarterPluginTestSuite();
 
 The test utilities in `__tests__/test-utils.ts` provide mock objects and setup functions to simplify writing tests.
 
-## Publishing
+## Publishing & Continuous Development
 
-Before publishing your plugin to the ElizaOS registry, ensure you meet these requirements:
+### Initial Setup
 
-1. **GitHub Repository**
+Before publishing your plugin, ensure you meet these requirements:
+
+1. **npm Authentication**
+
+   ```bash
+   npm login
+   ```
+
+2. **GitHub Repository**
 
    - Create a public GitHub repository for this plugin
    - Add the 'elizaos-plugins' topic to the repository
    - Use 'main' as the default branch
 
-2. **Required Assets**
-
+3. **Required Assets**
    - Add images to the `images/` directory:
      - `logo.jpg` (400x400px square, <500KB)
      - `banner.jpg` (1280x640px, <1MB)
 
-3. **Publishing Process**
+### Initial Publishing
+
+```bash
+# Test your plugin meets all requirements
+elizaos publish --test
+
+# Publish to npm + GitHub + registry (recommended)
+elizaos publish
+```
+
+This command will:
+
+- Publish your plugin to npm for easy installation
+- Create/update your GitHub repository
+- Submit your plugin to the ElizaOS registry for discoverability
+
+### Continuous Development & Updates
+
+**Important**: After your initial publish with `elizaos publish`, all future updates should be done using standard npm and git workflows, not the ElizaOS CLI.
+
+#### Standard Update Workflow
+
+1. **Make Changes**
+
+   ```bash
+   # Edit your plugin code
+   npm run dev  # Test locally with hot-reload
+   ```
+
+2. **Test Your Changes**
 
    ```bash
-   # Check if your plugin meets all registry requirements
-   npx elizaos publish --test
+   # Run all tests
+   elizaos test
 
-   # Publish to the registry
-   npx elizaos publish
+   # Run specific test types if needed
+   elizaos test component  # Component tests only
+   elizaos test e2e       # E2E tests only
    ```
 
-After publishing, your plugin will be submitted as a pull request to the ElizaOS registry for review.
+3. **Update Version**
+
+   ```bash
+   # Patch version (bug fixes): 1.0.0 → 1.0.1
+   npm version patch
+
+   # Minor version (new features): 1.0.1 → 1.1.0
+   npm version minor
+
+   # Major version (breaking changes): 1.1.0 → 2.0.0
+   npm version major
+   ```
+
+4. **Publish to npm**
+
+   ```bash
+   npm publish
+   ```
+
+5. **Push to GitHub**
+   ```bash
+   git push origin main
+   git push --tags  # Push version tags
+   ```
+
+#### Why Use Standard Workflows?
+
+- **npm publish**: Directly updates your package on npm registry
+- **git push**: Updates your GitHub repository with latest code
+- **Automatic registry updates**: The ElizaOS registry automatically syncs with npm, so no manual registry updates needed
+- **Standard tooling**: Uses familiar npm/git commands that work with all development tools
+
+### Alternative Publishing Options (Initial Only)
+
+```bash
+# Publish to npm only (skip GitHub and registry)
+elizaos publish --npm
+
+# Publish but skip registry submission
+elizaos publish --skip-registry
+
+# Generate registry files locally without publishing
+elizaos publish --dry-run
+```
 
 ## Configuration
 
@@ -130,3 +210,4 @@ Provide clear documentation about:
 - How to use it
 - Required API keys or credentials
 - Example usage
+- Version history and changelog

package/templates/plugin-starter/e2e/starter-plugin.test.ts

@@ -1,5 +1,5 @@
-import { starterPlugin } from '../src/index';
-import { Content as CoreContent, HandlerCallback } from '@elizaos/core';
+import { starterPlugin } from '../dist/index.js';
+import { type Content, type HandlerCallback } from '@elizaos/core';
 
 // Define a minimal TestSuite interface that matches what's needed
 interface TestSuite {
@@ -30,17 +30,11 @@ interface State {
   text: string;
 }
 
-interface Content {
-  text: string;
-  source?: string;
-  actions?: string[];
-}
+export const StarterPluginTestSuite: TestSuite = {
+  name: 'plugin_starter_test_suite',
+  description: 'E2E tests for the starter plugin',
 
-export class StarterPluginTestSuite implements TestSuite {
-  name = 'plugin_starter_test_suite';
-  description = 'E2E tests for the starter plugin';
-
-  tests = [
+  tests: [
     {
       name: 'example_test',
       fn: async (runtime) => {
@@ -97,7 +91,7 @@ export class StarterPluginTestSuite implements TestSuite {
         }
 
         // Create a callback that meets the HandlerCallback interface
-        const callback: HandlerCallback = async (response: CoreContent) => {
+        const callback: HandlerCallback = async (response: Content) => {
           if (response.text && response.actions?.includes('HELLO_WORLD')) {
             responseReceived = true;
           }
@@ -170,8 +164,8 @@ export class StarterPluginTestSuite implements TestSuite {
         await service.stop();
       },
     },
-  ];
-}
+  ],
+};
 
 // Export a default instance of the test suite for the E2E test runner
-export default new StarterPluginTestSuite();
+export default StarterPluginTestSuite;

package/templates/plugin-starter/package.json

@@ -36,13 +36,12 @@
     "dist"
   ],
   "dependencies": {
+    "@elizaos/core": "^1.0.0",
     "zod": "3.24.2"
   },
-  "peerDependencies": {
-    "@elizaos/core": "beta"
-  },
+  "peerDependencies": {},
   "devDependencies": {
-    "@elizaos/cli": "beta",
+    "@elizaos/cli": "^1.0.0",
     "dotenv": "16.4.5",
     "prettier": "3.5.3",
     "tsup": "8.4.0",
@@ -77,4 +76,4 @@
     }
   },
   "gitHead": "d5bd5c43bfebeb7ac02f9e029f924cb6cd5c2ec7"
-}
+}

package/templates/plugin-starter/src/index.ts

@@ -245,6 +245,7 @@ export const starterPlugin: Plugin = {
   services: [StarterService],
   actions: [helloWorldAction],
   providers: [helloWorldProvider],
+  dependencies: ['@elizaos/plugin-knowledge'],
 };
 
 export default starterPlugin;

package/templates/project-starter/.env.example

@@ -1,46 +1,152 @@
-# OpenAI Configuration (required if using the Openai LLM Plugin)
+### elizaOS Environment Variables ###
+# To get started, copy this file to .env, or make a .env and add the settings you'd like to override
+# Please read the comments for each of the configurations
+
+# The only thing you ABSOLUTELY NEED to get up and running is one of the model provider keys, 
+# i.e. OPENAI_API_KEY or ANTHROPIC_API_KEY, or setup the local-ai plugin
+# Everything else is optional, and most settings and secrets can be configured in your agent or through the GUI
+# For multi-agent, each agent will need keys for the various services it is connected to
+# You can use the .env or environment variables generally for shared keys, such as to model providers, 
+# database, etc, with scoped keys for services such as Telegram, Discord, etc
+
+### MODEL PROVIDER KEYS ###
+# Eliza is compatible with a wide array of model providers. Many have OpenAI compatible APIs, 
+# and you can use them by overriding the base URL
+
+# NOTE: You will need a provider that provides embeddings. So even if you use Claude, you will 
+# need to get embeddings using another provider, for example openai or our local-ai plugin
+
+# OpenAI Configuration
 OPENAI_API_KEY=
+# Use this to override the openai endpoint, for example for using together.ai, fireworks or other providers
+# OPENAI_BASE_URL=
 
-# Anthropic Configuration (required if using the Anthropic LLM Plugin)
+# Anthropic Configuration
+# By default in most of our starter kits, Anthropic will take precedence over OpenAI in handling requests
+# Anthropic does not handle embeddings, so you may wish to use OpenAI for that, even while Claude is handling text generation
 ANTHROPIC_API_KEY=
 
-# Fill these out if you want to use Discord (required if using the Discord plugin)
-DISCORD_APPLICATION_ID=
-DISCORD_API_TOKEN=
+# Cloudflare AI
+CLOUDFLARE_GW_ENABLED=
+CLOUDFLARE_AI_ACCOUNT_ID=
+CLOUDFLARE_AI_GATEWAY_ID=
+
+### LOCAL AI CONFIGURATION ###
+USE_LOCAL_AI=
+USE_STUDIOLM_TEXT_MODELS=
+USE_OLLAMA_TEXT_MODELS=
 
-# Fill these out if you want to use Postgres (required if using custom postgres url like neon db or railways)
+# Ollama Configuration
+OLLAMA_API_ENDPOINT=
+OLLAMA_MODEL=
+USE_OLLAMA_EMBEDDING=
+OLLAMA_EMBEDDING_MODEL=
+OLLAMA_SMALL_MODEL=
+OLLAMA_MEDIUM_MODEL=
+OLLAMA_LARGE_MODEL=
+
+# StudioLM Configuration
+STUDIOLM_SERVER_URL=
+STUDIOLM_SMALL_MODEL=
+STUDIOLM_MEDIUM_MODEL=
+STUDIOLM_EMBEDDING_MODEL=
+
+### DATABASE ###
+# By default, Eliza will use a local pglite instance
+# If you fill out POSTGRES_URL, the agent will connect to your postgres instance instead of using the local path
+
+# You can override the pglite data directory
+# PGLITE_DATA_DIR=/Users/UserName/eliza/packages/.pglite/
+
+# Fill this out if you want to use Postgres
 POSTGRES_URL=
 
-# Fill these out if you want to use Telegram (required if using the Telegram plugin)
+### LOGGING CONFIGURATION ###
+# Logging Configuration (supported: fatal, error, warn, info, debug, trace | default: info)
+LOG_LEVEL=
+
+# Sentry Configuration
+SENTRY_LOGGING=true
+SENTRY_DSN=
+SENTRY_ENVIRONMENT=
+SENTRY_TRACES_SAMPLE_RATE=
+SENTRY_SEND_DEFAULT_PII=
+
+### API KEYS ###
+# Many services require API keys to function
+# Most plugins will indicate what is needed in their README.md and throw helpful errors if they are missing
+BIRDEYE_API_KEY=
+JUPITER_API_KEY=
+HELIUS_API_KEY=
+COINMARKETCAP_API_KEY=
+ZEROEX_API_KEY=
+COINGECKO_API_KEY=
+
+### SINGLE AGENT VARIABLES ###
+# If you are running multiple agents, you will need to configure these variables in the agent secrets 
+# (available in the GUI) OR you can namespace the secrets and connect them up in your character definition
+
+# Example: 
+# settings: {
+#   process.env.COMMUNITY_MANAGER_DISCORD_API_TOKEN
+# }
+
+# Note: See below for multi-agent examples
+
+# Discord Configuration
+DISCORD_APPLICATION_ID=
+DISCORD_API_TOKEN=
+
+# Telegram Configuration
 TELEGRAM_BOT_TOKEN=
 
-# Fill these out if you want to use Twitter (required if using the Twitter plugin)
+# Twitter Configuration
 TWITTER_USERNAME=
 TWITTER_PASSWORD=
 TWITTER_EMAIL=
 TWITTER_ENABLE_POST_GENERATION=
+TWITTER_INTERACTION_ENABLE=
+TWITTER_TIMELINE_ENABLE=
+TWITTER_SPACES_ENABLE=
+TWITTER_TIMELINE_MODE=
+TWITTER_TIMELINE_POLL_INTERVAL=
 
-# Fill these out if you want to use EVM (required if using any wallet plugin)
+# EVM Configuration
 EVM_PRIVATE_KEY=
 EVM_CHAINS=mainnet,sepolia,base,arbitrum,polygon
 EVM_PROVIDER_URL=
 
-# Fill these out if you want to use Solana
+# Solana Configuration
 SOLANA_PUBLIC_KEY=
 SOLANA_PRIVATE_KEY=
-BIRDEYE_API_KEY=
 
-# Ollama Configuration (required if using the OLLAMA plugin)
-OLLAMA_API_ENDPOINT=
-OLLAMA_MODEL=
-USE_OLLAMA_EMBEDDING=
-OLLAMA_EMBEDDING_MODEL=
-OLLAMA_SMALL_MODEL=
-OLLAMA_MEDIUM_MODEL=
-OLLAMA_LARGE_MODEL=
+### MULTI-AGENT CONFIGURATION ###
+# Settings for The Org
+# The Org is an example of a multi-agent swarm
+# Available here: https://github.com/elizaOS/the-org
+# This is an example of how environment variables can be scoped per-project
 
-# StudioLM Configuration (required if using the StudioLM plugin)
-STUDIOLM_SERVER_URL=
-STUDIOLM_SMALL_MODEL=
-STUDIOLM_MEDIUM_MODEL=
-STUDIOLM_EMBEDDING_MODEL=
+# Community Manager
+COMMUNITY_MANAGER_DISCORD_APPLICATION_ID=
+COMMUNITY_MANAGER_DISCORD_API_TOKEN=
+
+# Social Media Manager
+SOCIAL_MEDIA_MANAGER_DISCORD_APPLICATION_ID=
+SOCIAL_MEDIA_MANAGER_DISCORD_API_TOKEN=
+
+# Liaison
+LIAISON_DISCORD_APPLICATION_ID=
+LIAISON_DISCORD_API_TOKEN=
+
+# Project Manager
+PROJECT_MANAGER_DISCORD_APPLICATION_ID=
+PROJECT_MANAGER_DISCORD_API_TOKEN=
+
+# Developer Relations
+DEV_REL_DISCORD_APPLICATION_ID=
+DEV_REL_DISCORD_API_TOKEN=
+DEVREL_IMPORT_KNOWLEDGE=true
+
+# Investment Manager
+INVESTMENT_MANAGER_DISCORD_APPLICATION_ID=
+INVESTMENT_MANAGER_DISCORD_API_TOKEN=

package/templates/project-starter/__tests__/config.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
 import plugin from '../src/plugin';
 import { z } from 'zod';
+import { createMockRuntime } from './utils/core-test-utils';
 
 // Mock logger
 vi.mock('@elizaos/core', async () => {
@@ -41,7 +42,7 @@ describe('Plugin Configuration Schema', () => {
     if (initPlugin) {
       let error = null;
       try {
-        await initPlugin(validConfig);
+        await initPlugin(validConfig, createMockRuntime());
       } catch (e) {
         error = e;
       }
@@ -55,7 +56,7 @@ describe('Plugin Configuration Schema', () => {
     if (initPlugin) {
       let error = null;
       try {
-        await initPlugin(emptyConfig);
+        await initPlugin(emptyConfig, createMockRuntime());
       } catch (e) {
         error = e;
       }
@@ -72,7 +73,7 @@ describe('Plugin Configuration Schema', () => {
     if (initPlugin) {
       let error = null;
       try {
-        await initPlugin(configWithExtra);
+        await initPlugin(configWithExtra, createMockRuntime());
       } catch (e) {
         error = e;
       }
@@ -88,7 +89,7 @@ describe('Plugin Configuration Schema', () => {
     if (initPlugin) {
       let error = null;
       try {
-        await initPlugin(invalidConfig);
+        await initPlugin(invalidConfig, createMockRuntime());
       } catch (e) {
         error = e;
       }
@@ -106,7 +107,7 @@ describe('Plugin Configuration Schema', () => {
       delete process.env.EXAMPLE_PLUGIN_VARIABLE;
 
       // Initialize with config
-      await initPlugin(testConfig);
+      await initPlugin(testConfig, createMockRuntime());
 
       // Verify environment variable was set
       expect(process.env.EXAMPLE_PLUGIN_VARIABLE).toBe('test-value');
@@ -118,11 +119,11 @@ describe('Plugin Configuration Schema', () => {
     process.env.EXAMPLE_PLUGIN_VARIABLE = 'pre-existing-value';
 
     const testConfig = {
-      EXAMPLE_PLUGIN_VARIABLE: undefined,
+      // Omit the variable to test that existing env vars aren't overridden
     };
 
     if (initPlugin) {
-      await initPlugin(testConfig);
+      await initPlugin(testConfig, createMockRuntime());
 
       // Verify environment variable was not changed
       expect(process.env.EXAMPLE_PLUGIN_VARIABLE).toBe('pre-existing-value');

package/templates/project-starter/__tests__/plugin.test.ts

@@ -21,24 +21,37 @@ afterAll(() => {
 
 // Helper function to document test results
 function documentTestResult(testName: string, result: any, error: Error | null = null) {
-  logger.info(`TEST: ${testName}`);
+  // Clean, useful test documentation for developers
+  logger.info(`✓ Testing: ${testName}`);
+
+  if (error) {
+    logger.error(`✗ Error: ${error.message}`);
+    if (error.stack) {
+      logger.error(`Stack: ${error.stack}`);
+    }
+    return;
+  }
+
   if (result) {
     if (typeof result === 'string') {
-      logger.info(`RESULT: ${result.substring(0, 100)}${result.length > 100 ? '...' : ''}`);
-    } else {
+      if (result.trim() && result.length > 0) {
+        const preview = result.length > 60 ? `${result.substring(0, 60)}...` : result;
+        logger.info(`  → ${preview}`);
+      }
+    } else if (typeof result === 'object') {
       try {
-        logger.info(`RESULT: ${JSON.stringify(result, null, 2).substring(0, 200)}...`);
+        // Show key information in a clean format
+        const keys = Object.keys(result);
+        if (keys.length > 0) {
+          const preview = keys.slice(0, 3).join(', ');
+          const more = keys.length > 3 ? ` +${keys.length - 3} more` : '';
+          logger.info(`  → {${preview}${more}}`);
+        }
       } catch (e) {
-        logger.info(`RESULT: [Complex object that couldn't be stringified]`);
+        logger.info(`  → [Complex object]`);
       }
     }
   }
-  if (error) {
-    logger.error(`ERROR: ${error.message}`);
-    if (error.stack) {
-      logger.error(`STACK: ${error.stack}`);
-    }
-  }
 }
 
 // Create a real runtime for testing
@@ -74,19 +87,14 @@ function createRealRuntime() {
       getKeys: async (pattern: string) => [],
     },
     getService: (serviceType: string) => {
-      // Log the service request for debugging
-      logger.debug(`Requesting service: ${serviceType}`);
-
       // Get from cache or create new
       if (!services.has(serviceType)) {
-        logger.debug(`Creating new service: ${serviceType}`);
         services.set(serviceType, createService(serviceType));
       }
 
       return services.get(serviceType);
     },
     registerService: (serviceType: string, service: any) => {
-      logger.debug(`Registering service: ${serviceType}`);
       services.set(serviceType, service);
     },
   };
@@ -109,7 +117,7 @@ describe('Plugin Configuration', () => {
     expect(plugin.config).toHaveProperty('EXAMPLE_PLUGIN_VARIABLE');
 
     documentTestResult('Plugin config check', {
-      hasExampleVariable: 'EXAMPLE_PLUGIN_VARIABLE' in plugin.config,
+      hasExampleVariable: plugin.config ? 'EXAMPLE_PLUGIN_VARIABLE' in plugin.config : false,
       configKeys: Object.keys(plugin.config || {}),
     });
   });
@@ -123,7 +131,7 @@ describe('Plugin Configuration', () => {
       // Initialize with config - using real runtime
       const runtime = createRealRuntime();
 
-      let error = null;
+      let error: Error | null = null;
       try {
         await plugin.init?.({ EXAMPLE_PLUGIN_VARIABLE: 'test-value' }, runtime as any);
         expect(true).toBe(true); // If we got here, init succeeded
@@ -149,7 +157,7 @@ describe('Plugin Configuration', () => {
     // Test with empty string (less than min length 1)
     if (plugin.init) {
       const runtime = createRealRuntime();
-      let error = null;
+      let error: Error | null = null;
 
       try {
         await plugin.init({ EXAMPLE_PLUGIN_VARIABLE: '' }, runtime as any);
@@ -165,7 +173,7 @@ describe('Plugin Configuration', () => {
         'Plugin invalid config',
         {
           errorThrown: !!error,
-          errorMessage: error?.message,
+          errorMessage: error?.message || 'No error message',
         },
         error
       );
@@ -235,10 +243,10 @@ describe('StarterService', () => {
   it('should start the service', async () => {
     const runtime = createRealRuntime();
     let startResult;
-    let error = null;
+    let error: Error | null = null;
 
     try {
-      logger.info('Starting StarterService');
+      logger.info('Using OpenAI for TEXT_SMALL model');
       startResult = await StarterService.start(runtime as any);
 
       expect(startResult).toBeDefined();
@@ -268,14 +276,14 @@ describe('StarterService', () => {
     const result1 = await StarterService.start(runtime as any);
     expect(result1).toBeTruthy();
 
-    let startupError: Error | unknown = null;
+    let startupError: Error | null = null;
 
     try {
       // Second registration should fail
       await StarterService.start(runtime as any);
       expect(true).toBe(false); // Should not reach here
     } catch (e) {
-      startupError = e;
+      startupError = e as Error;
       expect(e).toBeTruthy();
     }
 
@@ -283,15 +291,15 @@ describe('StarterService', () => {
       'StarterService double start',
       {
         errorThrown: !!startupError,
-        errorMessage: startupError instanceof Error ? startupError.message : String(startupError),
+        errorMessage: startupError?.message || 'No error message',
       },
-      startupError instanceof Error ? startupError : null
+      startupError
     );
   });
 
   it('should stop the service', async () => {
     const runtime = createRealRuntime();
-    let error = null;
+    let error: Error | null = null;
 
     try {
       // Register a real service first
@@ -324,7 +332,7 @@ describe('StarterService', () => {
     const runtime = createRealRuntime();
     // Don't register a service, so getService will return null
 
-    let error: Error | unknown = null;
+    let error: Error | null = null;
 
     try {
       // We'll patch the getService function to ensure it returns null
@@ -335,26 +343,21 @@ describe('StarterService', () => {
       // Should not reach here
       expect(true).toBe(false);
     } catch (e) {
-      error = e;
+      error = e as Error;
       // This is expected - verify it's the right error
       expect(error).toBeTruthy();
       if (error instanceof Error) {
         expect(error.message).toContain('Starter service not found');
       }
-    } finally {
-      // Restore original getService function if needed
-      if ('getService' in runtime && typeof runtime.getService !== 'function') {
-        delete runtime.getService;
-      }
     }
 
     documentTestResult(
       'StarterService non-existent stop',
       {
         errorThrown: !!error,
-        errorMessage: error instanceof Error ? error.message : String(error),
+        errorMessage: error?.message || 'No error message',
       },
-      error instanceof Error ? error : null
+      error
     );
   });