Skip to content

Latest commit

 

History

History

README.md

elizaOS CLI

Create and upgrade elizaOS projects and plugins.

Installation

# Interactive home screen
npx elizaos

# Or run a command directly
npx elizaos create

Commands

elizaos create

Create a new project from a packaged template.

# Interactive template selection
elizaos create

# Create a project
elizaos create my-project --template project

# Create a TypeScript plugin starter
elizaos create plugin-foo --template plugin

elizaos upgrade

Upgrade the current generated project to the latest packaged template.

elizaos upgrade
elizaos upgrade --check

elizaos info

Show available templates and languages.

elizaos info
elizaos info --template project
elizaos info --language typescript

elizaos plugins submit

Generate third-party plugin metadata and, when maintainers provide a writable registry repository, open a pull request for that registry. The public discovery path is npm publication with the elizaos keyword.

elizaos plugins submit --dry-run
elizaos plugins submit --registry owner/repo

elizaos deploy

Deploy the linked Eliza Cloud app for the current project by queueing a Cloud deployment and polling until it reaches READY or ERROR. The CLI itself does not run local build or Vercel orchestration; Eliza Cloud owns those deployment side effects. Use --dry-run to print the deployment plan without network calls.

elizaos deploy
elizaos deploy --app-id <id> --domain app.example.com
elizaos deploy --dry-run

elizaos capability-router connect

Connect a running Eliza agent to a remote capability-router endpoint or provision one via Eliza Cloud. See elizaos capability-router connect --help for the full flag list.

Templates

Template Description Languages
project Package-first elizaOS app with optional local source eject TypeScript
plugin Plugin starter workspace TypeScript

Development

bun run build
bun run test
bun run test:packaged