Upgrading your Inkeep version
Copy page
Upgrade the packages that make up the Inkeep Agent Framework
Overview
The Inkeep Agent Framework is composed of several npm packages:
@inkeep/agents-manage-api: The API for managing projects and agent configurations.@inkeep/agents-run-api: The API for executing conversations with your agents.@inkeep/agents-manage-ui: The UI for the visual builder and dashboard.@inkeep/agents-core: The core shared functionality of the agent framework.@inkeep/agents-sdk: The TypeScript SDK for building multi-agent systems.@inkeep/agents-cli: The CLI for managing and interacting with the agent framework.@inkeep/agents-ui: The UI library containing chat widget components.
Upgrading the quickstart template
Because the packages are pre-1.0.0, updates may contain breaking changes that require you to reset your database. Please upgrade at your own risk.
If you used the npx @inkeep/create-agents CLI command to create your workspace, run the following command from the workspace root:
This will update all the packages to the latest version and migrate your database schema to the latest version.
Troubleshooting:
If you encounter migration errors during the upgrade, this indicates a breaking schema change. You'll need to reset your database:
- Drop your database:
pnpm db:drop - Try again:
pnpm upgrade-agents
Upgrading the Agent CLI
If you installed the @inkeep/agents-cli package globally, you can upgrade it to the latest version by running the following command: