@elizaos/cli 1.0.0-alpha.0

package/package.json

@@ -0,0 +1,87 @@
+{
+	"name": "@elizaos/cli",
+	"version": "1.0.0-alpha.0",
+	"description": "elizaOS CLI - Manage your AI agents and plugins",
+	"publishConfig": {
+		"access": "public"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "elizaOS",
+		"url": "https://twitter.com/eliza_OS"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/elizaOS/eliza.git",
+		"directory": "packages/cli"
+	},
+	"files": [
+		"dist",
+		"templates"
+	],
+	"keywords": [],
+	"type": "module",
+	"exports": {
+		".": "./dist/index.js",
+		"./package.json": "./package.json"
+	},
+	"bin": {
+		"elizaos": "./dist/index.js"
+	},
+	"scripts": {
+		"cli": "bun build src/index.ts --outdir dist --watch",
+		"build": "tsup --format esm --dts",
+		"watch": "tsc --watch",
+		"dev": "tsup --format esm --dts --watch",
+		"typecheck": "tsc --noEmit",
+		"start:cli": "bun run build && node dist/index.js",
+		"release": "changeset version",
+		"pub:beta": "tsup --format esm && bun publish --no-git-checks --access public --tag beta",
+		"pub:next": "tsup --format esm && bun publish --no-git-checks --access public --tag next",
+		"pub:release": "tsup --format esm && bun publish --access public",
+		"test": "vitest run",
+		"test:dev": "REGISTRY_URL=http://localhost:3333 vitest run"
+	},
+	"dependencies": {
+		"@antfu/ni": "^0.21.4",
+		"@babel/core": "^7.22.1",
+		"@babel/parser": "^7.22.6",
+		"@babel/plugin-transform-typescript": "^7.22.5",
+		"@elizaos/core": "^0.25.9",
+		"@elizaos/plugin-sql": "^0.25.6",
+		"@noble/curves": "^1.8.1",
+		"axios": "^1.7.9",
+		"chalk": "5.2.0",
+		"commander": "^10.0.0",
+		"cosmiconfig": "^8.1.3",
+		"crypto": "^1.0.1",
+		"diff": "^5.1.0",
+		"dotenv": "^16.4.5",
+		"execa": "^7.0.0",
+		"fast-glob": "^3.3.2",
+		"fs-extra": "^11.1.0",
+		"https-proxy-agent": "^6.2.0",
+		"lodash": "^4.17.21",
+		"node-fetch": "^3.3.0",
+		"ora": "^6.1.2",
+		"papaparse": "^5.5.1",
+		"prompts": "^2.4.2",
+		"recast": "^0.23.2",
+		"ts-morph": "^18.0.0",
+		"tsconfig-paths": "^4.2.0",
+		"tsx": "^4.19.2",
+		"zod": "^3.20.2"
+	},
+	"devDependencies": {
+		"@types/babel__core": "^7.20.1",
+		"@types/diff": "^5.0.3",
+		"@types/fs-extra": "^11.0.1",
+		"@types/lodash": "^4.17.7",
+		"@types/prompts": "^2.4.2",
+		"rimraf": "^4.1.3",
+		"tsup": "8.4.0",
+		"type-fest": "^3.8.0",
+		"typescript": "5.8.2"
+	},
+	"gitHead": "084c3b06c279b85528a81d42fc93ef68ff9f7364"
+}

package/templates/plugin-starter/README.md

@@ -0,0 +1,2 @@
+# Plugin Starter
+

package/templates/plugin-starter/biome.json

@@ -0,0 +1,21 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.5.3/schema.json",
+	"extends": ["../../biome.json"],
+	"organizeImports": {
+		"enabled": false
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "space",
+		"indentWidth": 4,
+		"lineWidth": 100
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "single"
+		}
+	},
+	"files": {
+		"ignore": ["dist/**/*", "extra/**/*", "node_modules/**/*"]
+	}
+}

package/templates/plugin-starter/package.json

@@ -0,0 +1,37 @@
+{
+	"name": "@elizaos/plugin-starter",
+	"description": "Plugin starter for elizaOS",
+	"version": "1.0.0-alpha.0",
+	"type": "module",
+	"main": "dist/index.js",
+	"module": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		"./package.json": "./package.json",
+		".": {
+			"import": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.js"
+			}
+		}
+	},
+	"files": ["dist"],
+	"dependencies": {
+		"@elizaos/core": "workspace:*",
+		"zod": "3.21.4"
+	},
+	"devDependencies": {
+		"tsup": "8.4.0"
+	},
+	"scripts": {
+		"build": "tsup --format esm --dts",
+		"dev": "tsup --format esm --dts --watch",
+		"test": "vitest run"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"resolutions": {
+		"zod": "3.24.1"
+	}
+}

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

@@ -0,0 +1,252 @@
+import type { Plugin } from "@elizaos/core";
+import {
+	type Action,
+	type Content,
+	type GenerateTextParams,
+	type HandlerCallback,
+	type IAgentRuntime,
+	type Memory,
+	ModelTypes,
+	Service,
+	type State,
+	type Provider,
+	type ProviderResult,
+	logger,
+} from "@elizaos/core";
+import { z } from "zod";
+
+const configSchema = z.object({
+	PLUGIN_NAME: z
+		.string()
+		.min(1, "Plugin name is not provided")
+		.optional()
+		.transform((val) => {
+			if (!val) {
+				console.warn("Warning: Plugin name not provided");
+			}
+			return val;
+		}),
+});
+
+/**
+ * Example HelloWorld action
+ * This demonstrates the simplest possible action structure
+ */
+const helloWorldAction: Action = {
+	name: "HELLO_WORLD",
+	similes: ["GREET", "SAY_HELLO"],
+	description: "Responds with a simple hello world message",
+
+	validate: async (
+		_runtime: IAgentRuntime,
+		_message: Memory,
+		_state: State,
+	): Promise<boolean> => {
+		// Always valid
+		return true;
+	},
+
+	handler: async (
+		_runtime: IAgentRuntime,
+		message: Memory,
+		_state: State,
+		_options: any,
+		callback: HandlerCallback,
+		_responses: Memory[],
+	) => {
+		try {
+			logger.info("Handling HELLO_WORLD action");
+
+			// Simple response content
+			const responseContent: Content = {
+				text: "hello world!",
+				actions: ["HELLO_WORLD"],
+				source: message.content.source,
+			};
+
+			// Call back with the hello world message
+			await callback(responseContent);
+
+			return responseContent;
+		} catch (error) {
+			logger.error("Error in HELLO_WORLD action:", error);
+			throw error;
+		}
+	},
+
+	examples: [
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Can you say hello?",
+				},
+			},
+			{
+				name: "{{name2}}",
+				content: {
+					text: "hello world!",
+					actions: ["HELLO_WORLD"],
+				},
+			},
+		],
+	],
+};
+
+/**
+ * Example Hello World Provider
+ * This demonstrates the simplest possible provider implementation
+ */
+const helloWorldProvider: Provider = {
+	name: "HELLO_WORLD_PROVIDER",
+	description: "A simple example provider",
+
+	get: async (
+		_runtime: IAgentRuntime,
+		_message: Memory,
+		_state: State,
+	): Promise<ProviderResult> => {
+		return {
+			text: "I am a provider",
+			values: {},
+			data: {},
+		};
+	},
+};
+
+export class StarterService extends Service {
+	static serviceType = "starter";
+	capabilityDescription =
+		"This is a starter service which is attached to the agent through the starter plugin.";
+	constructor(protected runtime: IAgentRuntime) {
+		super(runtime);
+	}
+
+	static async start(runtime: IAgentRuntime) {
+		logger.info("*** Starting starter service ***");
+		const service = new StarterService(runtime);
+		return service;
+	}
+
+	static async stop(runtime: IAgentRuntime) {
+		logger.info("*** Stopping starter service ***");
+		// get the service from the runtime
+		const service = runtime.getService(StarterService.serviceType);
+		if (!service) {
+			throw new Error("Starter service not found");
+		}
+		service.stop();
+	}
+
+	async stop() {
+		logger.info("*** Stopping starter service instance ***");
+	}
+}
+
+export const starterPlugin: Plugin = {
+	name: "plugin-starter",
+	description: "Plugin starter for elizaOS",
+	config: {
+		PLUGIN_NAME: process.env.PLUGIN_NAME,
+	},
+	async init(config: Record<string, string>) {
+		logger.info("*** Initializing starter plugin ***");
+		try {
+			const validatedConfig = await configSchema.parseAsync(config);
+
+			// Set all environment variables at once
+			for (const [key, value] of Object.entries(validatedConfig)) {
+				if (value) process.env[key] = value;
+			}
+		} catch (error) {
+			if (error instanceof z.ZodError) {
+				throw new Error(
+					`Invalid plugin configuration: ${error.errors
+						.map((e) => e.message)
+						.join(", ")}`,
+				);
+			}
+			throw error;
+		}
+	},
+	models: {
+		[ModelTypes.TEXT_SMALL]: async (
+			_runtime,
+			{ prompt, stopSequences = [] }: GenerateTextParams,
+		) => {
+			return "Never gonna give you up, never gonna let you down, never gonna run around and desert you...";
+		},
+		[ModelTypes.TEXT_LARGE]: async (
+			_runtime,
+			{
+				prompt,
+				stopSequences = [],
+				maxTokens = 8192,
+				temperature = 0.7,
+				frequencyPenalty = 0.7,
+				presencePenalty = 0.7,
+			}: GenerateTextParams,
+		) => {
+			return "Never gonna make you cry, never gonna say goodbye, never gonna tell a lie and hurt you...";
+		},
+	},
+	tests: [
+		{
+			name: "plugin_starter_test_suite",
+			tests: [
+				{
+					name: "example_test",
+					fn: async (runtime) => {
+						console.log("example_test run by ", runtime.character.name);
+					},
+				},
+			],
+		},
+	],
+	routes: [
+		{
+			path: "/helloworld",
+			type: "GET",
+			handler: async (_req: any, res: any) => {
+				// send a response
+				res.json({
+					message: "Hello World!",
+				});
+			},
+		},
+	],
+	events: {
+		MESSAGE_RECEIVED: [
+			async (params) => {
+				console.log("MESSAGE_RECEIVED event received");
+				// print the keys
+				console.log(Object.keys(params));
+			},
+		],
+		VOICE_MESSAGE_RECEIVED: [
+			async (params) => {
+				console.log("VOICE_MESSAGE_RECEIVED event received");
+				// print the keys
+				console.log(Object.keys(params));
+			},
+		],
+		SERVER_CONNECTED: [
+			async (params) => {
+				console.log("SERVER_CONNECTED event received");
+				// print the keys
+				console.log(Object.keys(params));
+			},
+		],
+		SERVER_JOINED: [
+			async (params) => {
+				console.log("SERVER_JOINED event received");
+				// print the keys
+				console.log(Object.keys(params));
+			},
+		],
+	},
+	services: [StarterService],
+	actions: [helloWorldAction],
+	providers: [helloWorldProvider],
+};
+export default starterPlugin;

package/templates/plugin-starter/tsconfig.json

@@ -0,0 +1,25 @@
+{
+	"compilerOptions": {
+		"outDir": "dist",
+		"rootDir": "src",
+		"lib": ["ESNext"],
+		"target": "ESNext",
+		"module": "Preserve",
+		"moduleResolution": "Bundler",
+		"strict": false,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": false,
+		"allowImportingTsExtensions": true,
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"resolveJsonModule": true,
+		"noImplicitAny": false,
+		"allowJs": true,
+		"checkJs": false,
+		"noEmitOnError": false,
+		"moduleDetection": "force",
+		"allowArbitraryExtensions": true
+	},
+	"include": ["src/**/*.ts"]
+}

package/templates/plugin-starter/tsup.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+	entry: ["src/index.ts"],
+	outDir: "dist",
+	sourcemap: true,
+	clean: true,
+	format: ["esm"], // Ensure you're targeting CommonJS
+	external: [
+		"dotenv", // Externalize dotenv to prevent bundling
+		"fs", // Externalize fs to use Node.js built-in module
+		"path", // Externalize other built-ins if necessary
+		"https",
+		"http",
+		"@elizaos/core",
+	],
+});

package/templates/plugin-starter/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+	test: {
+		globals: true,
+		environment: "node",
+	},
+});

package/templates/project-starter/README.md

@@ -0,0 +1,2 @@
+# Plugin Starter
+

package/templates/project-starter/biome.json

@@ -0,0 +1,21 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.5.3/schema.json",
+	"extends": ["../../biome.json"],
+	"organizeImports": {
+		"enabled": false
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "space",
+		"indentWidth": 4,
+		"lineWidth": 100
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "single"
+		}
+	},
+	"files": {
+		"ignore": ["dist/**/*", "extra/**/*", "node_modules/**/*"]
+	}
+}

package/templates/project-starter/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "@elizaos/project-starter",
+	"description": "Project starter for elizaOS",
+	"version": "1.0.0-alpha.0",
+	"type": "module",
+	"main": "dist/index.js",
+	"module": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		"./package.json": "./package.json",
+		".": {
+			"import": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.js"
+			}
+		}
+	},
+	"files": ["dist"],
+	"dependencies": {
+		"@elizaos/core": "workspace:*",
+		"zod": "3.21.4"
+	},
+	"devDependencies": {
+		"tsup": "8.4.0"
+	},
+	"scripts": {
+		"build": "tsup --format esm --dts",
+		"dev": "tsup --format esm --dts --watch",
+		"test": "vitest run"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}