Commands
Update Command
Update your project’s ElizaOS dependencies and CLI to the latest published versions
Update Command
Update ElizaOS CLI and project dependencies.
Usage
Options
Option | Description |
---|---|
-c, --check | Check for available updates without applying them |
--skip-build | Skip building after updating |
--cli | Update only the global CLI installation (without updating packages) |
--packages | Update only packages (without updating the CLI) |
Usage
Options
Option | Description |
---|---|
-c, --check | Check for available updates without applying them |
--skip-build | Skip building after updating |
--cli | Update only the global CLI installation (without updating packages) |
--packages | Update only packages (without updating the CLI) |
Update Process Explained
When you run elizaos update
, it performs the following steps:
- Detects Project Type: Determines if you’re in an ElizaOS project or plugin.
- Checks CLI Version: Compares your installed CLI version with the latest available on npm.
- Scans Dependencies: Finds all
@elizaos/*
packages in your project’spackage.json
. - Shows Update Plan: Lists the packages and/or CLI that have available updates.
- Prompts for Confirmation: Asks for your approval before making any changes.
- Updates Packages: Installs the latest versions of the packages.
- Rebuilds Project: Compiles the updated dependencies (unless
--skip-build
is used).
Workspace & Monorepo Support
The update command is smart enough to detect monorepo workspaces. It will automatically skip any packages that are linked via workspace:*
in your package.json
, as these should be managed within the monorepo, not from the npm registry.
Best Practices
Safe Update Process
For the smoothest update experience, follow this sequence:
- Check what will be updated:
elizaos update --check
- Commit your current work:
git commit -am "chore: pre-update savepoint"
- Update the CLI first:
elizaos update --cli
- Then, update project packages:
elizaos update --packages
- Test your project thoroughly:
elizaos test
Project Detection
The update command automatically detects:
- ElizaOS Projects: Updates project dependencies and rebuilds
- ElizaOS Plugins: Updates plugin dependencies and rebuilds
- Non-ElizaOS Projects: Shows error message
Workspace Support
Monorepo Detection
- Automatically detects workspace references
- Skips packages with
workspace:*
versions - Shows which packages are workspace-managed
Example with Workspaces
Version Strategy
Staying Current
- Update regularly to get latest features and fixes
- Use
--check
to monitor available updates - Subscribe to ElizaOS release notes
Stability Considerations
- Test updates in development before production
- Consider pinning versions for production deployments
- Review changelogs for breaking changes
Troubleshooting
CLI Update Issues
If you have trouble updating the global CLI:
Package Update Failures
If package updates fail, a clean reinstall usually fixes it:
Build Failures After Update
If your project fails to build after an update: