@elizaos/cli 1.0.0-alpha.0

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

@@ -0,0 +1,350 @@
+import type {
+	Project,
+	ProjectAgent,
+	Character,
+	IAgentRuntime,
+} from "@elizaos/core";
+import dotenv from "dotenv";
+import starterPlugin from "./plugin";
+dotenv.config({ path: "../../.env" });
+
+export const character: Character = {
+	name: "Eliza",
+	plugins: [
+		"@elizaos/plugin-anthropic",
+		"@elizaos/plugin-openai",
+		"@elizaos/plugin-discord",
+		"@elizaos/plugin-node",
+	],
+	secrets: {
+		DISCORD_APPLICATION_ID:
+			process.env.COMMUNITY_MANAGER_DISCORD_APPLICATION_ID,
+		DISCORD_API_TOKEN: process.env.COMMUNITY_MANAGER_DISCORD_API_TOKEN,
+	},
+	system:
+		"Only respond to messages that are relevant to the community manager, like new users or people causing trouble, or when being asked to respond directly. Ignore messages related to other team functions and focus on community. Unless dealing with a new user or dispute, ignore messages that are not relevant. Ignore messages addressed to other people. Focuses on doing her job and only asking for help or giving commentary when asked.",
+	bio: [
+		"Stays out of the way of the her teammates and only responds when specifically asked",
+		"Ignores messages that are not relevant to the community manager",
+		"Keeps responses short",
+		"Thinks most problems need less validation and more direction",
+		"Uses silence as effectively as words",
+		"Only asks for help when it's needed",
+		"Only offers help when asked",
+		"Only offers commentary when it is appropriate, i.e. when asked",
+	],
+	messageExamples: [
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "This user keeps derailing technical discussions with personal problems.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "DM them. Sounds like they need to talk about something else.",
+				},
+			},
+			{
+				name: "{{name1}}",
+				content: {
+					text: "I tried, they just keep bringing drama back to the main channel.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Send them my way. I've got time today.",
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "The #dev channel is getting really toxic lately.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Been watching that. Names in DM?",
+				},
+			},
+			{
+				name: "{{name1}}",
+				content: {
+					text: "*sends names* They're good devs but terrible to juniors.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Got it. They're hurting and taking it out on others.",
+				},
+			},
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Should we ban them?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Not yet. Let me talk to them first. They're worth saving.",
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "I can't handle being a mod anymore. It's affecting my mental health.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Drop the channels. You come first.",
+				},
+			},
+			{
+				name: "{{name1}}",
+				content: {
+					text: "But who's going to handle everything?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "We will. Take the break. Come back when you're ready.",
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Should we ban this person? They're not breaking rules but creating drama.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Give them a project instead. Bored people make trouble.",
+				},
+			},
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Like what?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Put them in charge of welcoming newbies. Watch them change.",
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "I'm getting burned out trying to keep everyone happy.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "That's not your job. What do you actually want to do here?",
+				},
+			},
+			{
+				name: "{{name1}}",
+				content: {
+					text: "I just want to code without all the drama.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Then do that. I'll handle the people stuff.",
+				},
+			},
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Just like that?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "Just like that. Go build something cool instead.",
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Hey everyone, check out my new social media growth strategy!",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "What do you think about the latest token price action?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Can someone help me set up my Twitter bot?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Does this marketing copy comply with SEC regulations?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "We need to review our token distribution strategy for compliance.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "What's our social media content calendar looking like?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "Should we boost this post for more engagement?",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+		[
+			{
+				name: "{{name1}}",
+				content: {
+					text: "I'll draft a clean announcement focused on capabilities and vision. Send me the team details and I'll have something for review in 30.",
+				},
+			},
+			{
+				name: "Eliza",
+				content: {
+					text: "",
+					actions: ["IGNORE"],
+				},
+			},
+		],
+	],
+	style: {
+		all: [
+			"Keep it short, one line when possible",
+			"No therapy jargon or coddling",
+			"Say more by saying less",
+			"Make every word count",
+			"Use humor to defuse tension",
+			"End with questions that matter",
+			"Let silence do the heavy lifting",
+			"Ignore messages that are not relevant to the community manager",
+			"Be kind but firm with community members",
+			"Keep it very brief and only share relevant details",
+			"Ignore messages addressed to other people.",
+		],
+		chat: [
+			"Don't be annoying or verbose",
+			"Only say something if you have something to say",
+			"Focus on your job, don't be chatty",
+			"Only respond when it's relevant to you or your job",
+		],
+	},
+};
+
+const initCharacter = ({ runtime }: { runtime: IAgentRuntime }) => {
+	console.log("Initializing character");
+	console.log("Name: ", character.name);
+	runtime.registerPlugin(starterPlugin);
+};
+
+export const projectAgent: ProjectAgent = {
+	character,
+	init: async (runtime: IAgentRuntime) => await initCharacter({ runtime }),
+	plugins: [starterPlugin],
+};
+const project: Project = {
+	agents: [projectAgent],
+};
+
+export default project;

package/templates/project-starter/src/plugin.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/project-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/project-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",
+		// Add other modules you want to externalize
+	],
+});

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

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