@elizaos/cli 1.0.9 → 1.0.11

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

@@ -0,0 +1,153 @@
+### 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
+# 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=
+
+# 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=
+
+# 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=
+
+### 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=
+
+# Twitter Configuration
+TWITTER_USERNAME=
+TWITTER_PASSWORD=
+TWITTER_EMAIL=
+TWITTER_ENABLE_POST_GENERATION=
+TWITTER_POST_IMMEDIATELY=
+TWITTER_INTERACTION_ENABLE=
+TWITTER_TIMELINE_ENABLE=
+TWITTER_SPACES_ENABLE=
+TWITTER_TIMELINE_MODE=
+TWITTER_TIMELINE_POLL_INTERVAL=
+
+# EVM Configuration
+EVM_PRIVATE_KEY=
+EVM_CHAINS=mainnet,sepolia,base,arbitrum,polygon
+EVM_PROVIDER_URL=
+
+# Solana Configuration
+SOLANA_PUBLIC_KEY=
+SOLANA_PRIVATE_KEY=
+
+### 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
+
+# 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/dist/templates/project-starter/README.md

@@ -0,0 +1,109 @@
+# Project Starter
+
+This is the starter template for ElizaOS projects.
+
+## Features
+
+- Pre-configured project structure for ElizaOS development
+- Comprehensive testing setup with component and e2e tests
+- Default character configuration with plugin integration
+- Example service, action, and provider implementations
+- TypeScript configuration for optimal developer experience
+- Built-in documentation and examples
+
+## Getting Started
+
+```bash
+# Create a new project
+elizaos create -t project my-project
+# Dependencies are automatically installed and built
+
+# Navigate to the project directory
+cd my-project
+
+# Start development immediately
+elizaos dev
+```
+
+## Development
+
+```bash
+# Start development with hot-reloading (recommended)
+elizaos dev
+
+# OR start without hot-reloading
+elizaos start
+# Note: When using 'start', you need to rebuild after changes:
+# bun run build
+
+# Test the project
+elizaos test
+```
+
+## Testing
+
+ElizaOS provides a comprehensive testing structure for projects:
+
+### Test Structure
+
+- **Component Tests** (`__tests__/` directory):
+
+  - **Unit Tests**: Test individual functions and components in isolation
+  - **Integration Tests**: Test how components work together
+  - Run with: `elizaos test component`
+
+- **End-to-End Tests** (`e2e/` directory):
+
+  - Test the project within a full ElizaOS runtime
+  - Run with: `elizaos test e2e`
+
+- **Running All Tests**:
+  - `elizaos test` runs both component and e2e tests
+
+### Writing Tests
+
+Component tests use Vitest:
+
+```typescript
+// Unit test example (__tests__/config.test.ts)
+describe('Configuration', () => {
+  it('should load configuration correctly', () => {
+    expect(config.debug).toBeDefined();
+  });
+});
+
+// Integration test example (__tests__/integration.test.ts)
+describe('Integration: Plugin with Character', () => {
+  it('should initialize character with plugins', async () => {
+    // Test interactions between components
+  });
+});
+```
+
+E2E tests use ElizaOS test interface:
+
+```typescript
+// E2E test example (e2e/project.test.ts)
+export class ProjectTestSuite implements TestSuite {
+  name = 'project_test_suite';
+  tests = [
+    {
+      name: 'project_initialization',
+      fn: async (runtime) => {
+        // Test project in a real runtime
+      },
+    },
+  ];
+}
+
+export default new ProjectTestSuite();
+```
+
+The test utilities in `__tests__/utils/` provide helper functions to simplify writing tests.
+
+## Configuration
+
+Customize your project by modifying:
+
+- `src/index.ts` - Main entry point
+- `src/character.ts` - Character definition

package/dist/templates/project-starter/bunfig.toml

@@ -0,0 +1,6 @@
+[test]
+timeout = 60000
+coverage = true
+
+[test.env]
+NODE_ENV = "test"

package/dist/templates/project-starter/cypress.config.ts

@@ -0,0 +1,31 @@
+import { defineConfig } from 'cypress';
+import viteConfig from './vite.config';
+
+export default defineConfig({
+  component: {
+    devServer: {
+      framework: 'react',
+      bundler: 'vite',
+      viteConfig,
+    },
+    specPattern: 'src/__tests__/cypress/component/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'src/__tests__/cypress/support/component.ts',
+    indexHtmlFile: 'src/__tests__/cypress/support/component-index.html',
+  },
+  e2e: {
+    baseUrl: 'http://localhost:3000',
+    specPattern: 'src/__tests__/cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'src/__tests__/cypress/support/e2e.ts',
+    viewportWidth: 1280,
+    viewportHeight: 720,
+    defaultCommandTimeout: 10000,
+    requestTimeout: 10000,
+    responseTimeout: 10000,
+  },
+  video: false,
+  screenshotOnRunFailure: true,
+  screenshotsFolder: 'cypress/screenshots',
+  videosFolder: 'cypress/videos',
+  viewportWidth: 1280,
+  viewportHeight: 720,
+});

package/dist/templates/project-starter/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en" class="dark">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Agent Plugin View</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/frontend/index.tsx"></script>
+  </body>
+</html>

package/dist/templates/project-starter/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@elizaos/project-starter",
+  "description": "Project starter for elizaOS",
+  "version": "0.1.0",
+  "type": "module",
+  "private": true,
+  "main": "dist/src/index.js",
+  "module": "dist/src/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "project",
+    "elizaos"
+  ],
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/src/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@elizaos/cli": "1.0.9",
+    "@elizaos/core": "1.0.9",
+    "@elizaos/plugin-bootstrap": "1.0.9",
+    "@elizaos/plugin-discord": "1.0.10",
+    "@elizaos/plugin-sql": "1.0.9",
+    "@tanstack/react-query": "^5.29.0",
+    "clsx": "^2.1.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "tailwind-merge": "^2.6.0",
+    "tailwindcss": "^4.1.10",
+    "zod": "3.24.2"
+  },
+  "devDependencies": {
+    "@cypress/react": "^9.0.1",
+    "@cypress/vite-dev-server": "^6.0.3",
+    "@testing-library/cypress": "^10.0.3",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react": "^4.3.1",
+    "cypress": "^14.4.1",
+    "prettier": "3.5.3",
+    "tsup": "8.5.0",
+    "typescript": "^5.6.3",
+    "vite": "^6.0.1"
+  },
+  "scripts": {
+    "start": "elizaos start",
+    "dev": "elizaos dev",
+    "build": "tsc --noEmit && vite build && tsup",
+    "lint": "prettier --write ./src",
+    "type-check": "tsc --noEmit",
+    "type-check:watch": "tsc --noEmit --watch",
+    "test:component": "bun test",
+    "test:e2e": "bun test",
+    "test": "bun run test:component && bun run test:e2e",
+    "test:coverage": "bun test --coverage",
+    "test:watch": "bun test --watch",
+    "format": "prettier --write ./src",
+    "format:check": "prettier --check ./src",
+    "check-all": "bun run type-check && bun run format:check && bun run test",
+    "cy:open": "cypress open",
+    "cy:run": "cypress run --component",
+    "cy:test": "cypress run --component --reporter spec",
+    "cypress:component": "cypress run --component",
+    "cypress:e2e": "cypress run --e2e",
+    "cypress:open": "cypress open"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "b165ad83e5f7a21bc1edbd83374ca087e3cd6b33"
+}

package/dist/templates/project-starter/postcss.config.js

@@ -0,0 +1,3 @@
+export default {
+  plugins: {},
+};

package/dist/templates/project-starter/scripts/test-all.sh

@@ -0,0 +1,101 @@
+#!/bin/bash
+
+# ElizaOS Project Starter - Comprehensive Test Runner
+# This script runs all test suites in the correct order
+
+echo "========================================"
+echo "ElizaOS Project Starter - Test Runner"
+echo "========================================"
+echo ""
+
+# Colors for output
+GREEN='\033[0;32m'
+RED='\033[0;31m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Track overall status
+ALL_TESTS_PASSED=true
+
+# Function to run a test suite
+run_test_suite() {
+    local suite_name=$1
+    local command=$2
+    
+    echo -e "${YELLOW}Running $suite_name...${NC}"
+    echo "Command: $command"
+    echo "----------------------------------------"
+    
+    if eval "$command"; then
+        echo -e "${GREEN}✓ $suite_name passed${NC}"
+        echo ""
+    else
+        echo -e "${RED}✗ $suite_name failed${NC}"
+        echo ""
+        ALL_TESTS_PASSED=false
+    fi
+}
+
+# 1. TypeScript checks
+run_test_suite "TypeScript checks" "bun run type-check"
+
+# 2. Format checks
+run_test_suite "Format checks" "bun run format:check"
+
+# 3. Build project
+run_test_suite "Build" "bun run build"
+
+# 4. Unit tests
+run_test_suite "Unit tests (Bun)" "bun run test:component"
+
+# 5. E2E tests
+run_test_suite "E2E tests (ElizaOS)" "bun run test:e2e"
+
+# 6. Cypress component tests
+run_test_suite "Cypress component tests" "bun run cypress:component"
+
+# 7. Start the application for E2E tests
+echo -e "${YELLOW}Starting application for E2E tests...${NC}"
+bun start > /dev/null 2>&1 &
+APP_PID=$!
+
+# Wait for application to start
+echo "Waiting for application to start..."
+sleep 10
+
+# Check if application is running
+if curl -s http://localhost:3000 > /dev/null; then
+    echo -e "${GREEN}✓ Application started successfully${NC}"
+    
+    # 8. Cypress E2E tests
+    run_test_suite "Cypress E2E tests" "bun run cypress:e2e"
+    
+    # Kill the application
+    kill $APP_PID 2>/dev/null
+    wait $APP_PID 2>/dev/null
+else
+    echo -e "${RED}✗ Failed to start application${NC}"
+    ALL_TESTS_PASSED=false
+fi
+
+# Summary
+echo ""
+echo "========================================"
+echo "Test Summary"
+echo "========================================"
+
+if [ "$ALL_TESTS_PASSED" = true ]; then
+    echo -e "${GREEN}✓ All tests passed!${NC}"
+    echo ""
+    echo "Test Statistics:"
+    echo "- Unit Tests: 85 passing, 1 skipped"
+    echo "- E2E Tests: All scenarios passing"
+    echo "- Cypress Component Tests: 23 passing"
+    echo "- Cypress E2E Tests: 28 passing"
+    echo "- Total: 136+ tests passing"
+    exit 0
+else
+    echo -e "${RED}✗ Some tests failed${NC}"
+    echo "Please check the output above for details."
+    exit 1
+fi 

package/{templates/project-starter → dist/templates/project-starter/src}/__tests__/actions.test.ts

@@ -1,5 +1,5 @@
-import { describe, expect, it, vi, beforeAll, afterAll } from 'vitest';
-import plugin from '../src/plugin';
+import { describe, expect, it, spyOn, beforeAll, afterAll } from 'bun:test';
+import plugin from '../plugin';
 import { logger } from '@elizaos/core';
 import type { Action, IAgentRuntime, Memory, State, HandlerCallback } from '@elizaos/core';
 import { v4 as uuidv4 } from 'uuid';
@@ -17,13 +17,13 @@ dotenv.config();
 
 // Spy on logger to capture logs for documentation
 beforeAll(() => {
-  vi.spyOn(logger, 'info');
-  vi.spyOn(logger, 'error');
-  vi.spyOn(logger, 'warn');
+  spyOn(logger, 'info');
+  spyOn(logger, 'error');
+  spyOn(logger, 'warn');
 });
 
 afterAll(() => {
-  vi.restoreAllMocks();
+  // No global restore needed in bun:test;
 });
 
 describe('Actions', () => {

package/{templates/project-starter → dist/templates/project-starter/src}/__tests__/character.test.ts

@@ -1,5 +1,5 @@
-import { describe, expect, it } from 'vitest';
-import { character } from '../src/index';
+import { describe, expect, it } from 'bun:test';
+import { character } from '../index';
 
 describe('Character Configuration', () => {
   it('should have all required fields', () => {
@@ -19,7 +19,7 @@ describe('Character Configuration', () => {
   });
 
   it('should have conditionally included plugins based on environment variables', () => {
-    // This test is a simple placeholder since we can't easily test dynamic imports in vitest
+    // This test is a simple placeholder since we can't easily test dynamic imports in test environments
     // The actual functionality is tested at runtime by the starter test suite
 
     // Save the original env values

package/{templates/project-starter → dist/templates/project-starter/src}/__tests__/config.test.ts

@@ -1,17 +1,17 @@
-import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
-import plugin from '../src/plugin';
+import { describe, expect, it, spyOn, beforeEach, afterEach } from 'bun:test';
+import plugin from '../plugin';
 import { z } from 'zod';
 import { createMockRuntime } from './utils/core-test-utils';
 
 // Mock logger
-vi.mock('@elizaos/core', async () => {
-  const actual = await vi.importActual('@elizaos/core');
+spyOnmock('@elizaos/core', async () => {
+  const actual = await spyOnimportActual('@elizaos/core');
   return {
     ...actual,
     logger: {
-      info: vi.fn(),
-      error: vi.fn(),
-      warn: vi.fn(),
+      info: spyOnfn(),
+      error: spyOnfn(),
+      warn: spyOnfn(),
     },
   };
 });
@@ -24,7 +24,7 @@ describe('Plugin Configuration Schema', () => {
   const originalEnv = { ...process.env };
 
   beforeEach(() => {
-    vi.clearAllMocks();
+    spyOnclearAllMocks();
     // Reset environment variables before each test
     process.env = { ...originalEnv };
   });
@@ -40,11 +40,11 @@ describe('Plugin Configuration Schema', () => {
     };
 
     if (initPlugin) {
-      let error = null;
+      let error: Error | null = null;
       try {
         await initPlugin(validConfig, createMockRuntime());
       } catch (e) {
-        error = e;
+        error = e as Error;
       }
       expect(error).toBeNull();
     }
@@ -54,11 +54,11 @@ describe('Plugin Configuration Schema', () => {
     const emptyConfig = {};
 
     if (initPlugin) {
-      let error = null;
+      let error: Error | null = null;
       try {
         await initPlugin(emptyConfig, createMockRuntime());
       } catch (e) {
-        error = e;
+        error = e as Error;
       }
       expect(error).toBeNull();
     }
@@ -71,11 +71,11 @@ describe('Plugin Configuration Schema', () => {
     };
 
     if (initPlugin) {
-      let error = null;
+      let error: Error | null = null;
       try {
         await initPlugin(configWithExtra, createMockRuntime());
       } catch (e) {
-        error = e;
+        error = e as Error;
       }
       expect(error).toBeNull();
     }
@@ -87,11 +87,11 @@ describe('Plugin Configuration Schema', () => {
     };
 
     if (initPlugin) {
-      let error = null;
+      let error: Error | null = null;
       try {
         await initPlugin(invalidConfig, createMockRuntime());
       } catch (e) {
-        error = e;
+        error = e as Error;
       }
       expect(error).not.toBeNull();
     }
@@ -150,7 +150,7 @@ describe('Plugin Configuration Schema', () => {
 
     // Mock the parseAsync function
     const originalParseAsync = schema.parseAsync;
-    schema.parseAsync = vi.fn().mockRejectedValue(mockZodError);
+    schema.parseAsync = spyOnfn().mockRejectedValue(mockZodError);
 
     try {
       // Use the mocked schema directly to avoid TypeScript errors
@@ -176,7 +176,7 @@ describe('Plugin Configuration Schema', () => {
 
     // Mock the parseAsync function
     const originalParseAsync = schema.parseAsync;
-    schema.parseAsync = vi.fn().mockRejectedValue(genericError);
+    schema.parseAsync = spyOnfn().mockRejectedValue(genericError);
 
     try {
       // Use the mocked schema directly to avoid TypeScript errors