@daydreamsai/create-agent

A CLI tool to bootstrap Daydreams agents easily.

Usage

# Using npx (recommended)
npx @daydreamsai/create-agent my-agent

# Or install globally
npm install -g @daydreamsai/create-agent
create-agent my-agent

Options

You can specify extensions to include:

npx @daydreamsai/create-agent my-agent --twitter --discord --cli

Available extensions:

• --cli: Include CLI extension
• --twitter: Include Twitter extension
• --discord: Include Discord extension
• --telegram: Include Telegram extension
• --all: Include all extensions

If no extensions are specified, you will be prompted to select which ones to include.

What it does

This tool:

1. Creates a new directory for your agent (or uses the current directory)
2. Sets up a package.json with the necessary dependencies
3. Creates an index.js file with the selected extensions
4. Generates a basic .env.example file with required environment variables
5. Installs all dependencies

Development

# Install dependencies
pnpm install

# Build the package
pnpm run build

# Test the CLI locally
pnpm run start

Testing

The create-agent CLI is tested using Vitest. To run tests:

# Run all tests
pnpm run test

# Run tests in watch mode during development
pnpm run test:watch

# Run tests with coverage report
pnpm run test:coverage

Test Structure

• test/index.test.ts: Main CLI integration tests
• test/utils/utils.test.ts: Unit tests for utility functions
• test/template-generation.test.ts: Tests for template generation functionality

Adding New Tests

When adding new features to the CLI, make sure to:

1. Extract pure functions to the src/utils.ts file where possible
2. Add unit tests for those functions in test/utils/utils.test.ts
3. Add integration tests for CLI behavior in test/index.test.ts