ContextQMD
Back to Eliza

elizaOS CLI

packages/elizaos/README.md

1.7.22.2 KB
Original Source

elizaOS CLI

Create and manage elizaOS example projects.

Installation

bash
# Using npx (no installation required)
npx elizaos create

# Using bunx (no installation required)
bunx elizaos create

# Or install globally
npm install -g elizaos

Commands

elizaos version

Display version information.

bash
elizaos version

elizaos info

Display information about available examples.

bash
# Show all examples
elizaos info

# Filter by language
elizaos info --language typescript
elizaos info --language python
elizaos info --language rust

# Output as JSON
elizaos info --json

elizaos create

Create a new elizaOS example project.

bash
# Interactive mode
elizaos create

# With project name
elizaos create my-project

# With options
elizaos create my-project --language typescript --example chat

# Skip prompts
elizaos create my-chat --language python --example chat --yes

Available Examples

ExampleDescriptionLanguages
chatInteractive CLI chat with AI agentTypeScript, Python, Rust
text-adventureText adventure game with AITypeScript, Python, Rust
tic-tac-toeTic-tac-toe game demoTypeScript, Python
rest-apiREST API implementationsTypeScript, Python, Rust
a2aAgent-to-Agent communicationTypeScript, Python, Rust
mcpModel Context ProtocolTypeScript, Python, Rust
reactReact web applicationTypeScript
nextNext.js applicationTypeScript
awsAWS Lambda deploymentTypeScript, Python, Rust
gcpGoogle Cloud PlatformTypeScript, Python, Rust
cloudflareCloudflare WorkersTypeScript, Python, Rust
vercelVercel Edge FunctionsTypeScript, Python, Rust

Development

bash
# Build the CLI
bun run build

# Run locally
bun run src/cli.ts version
bun run src/cli.ts info
bun run src/cli.ts create

License

MIT