AI agents: the content index is at /llms.txt. Every page is also available as Markdown — send the request header Accept: text/markdown, or append .md to the page URL.
Xperience Docs

Cookie consent

We use necessary cookies (opens in a new tab) to run our website and improve your experience while browsing. Additional cookies are only used with your consent. You may revoke your consent on the Cookies Policy (opens in a new tab) page or in your browser at any time.

Configure (opens in a new tab)
  • Documentation
    Administration interface basicsDevelopers and adminsBusiness usersChangelogGlossary
  • Guides
    Welcome to Xperience by KenticoAdministration interface basicsCustomer journeysDigital marketingConfigurationDevelopmentArchitectureUpgrade to Xperience by Kentico
  • Training
    For AdminsFor Business usersFor DevelopersFor Solution architects
  • API Examples
    ConfigurationContent managementDevelopmentDigital marketing
  • Changelog
    Documentation updatesSecurity advisories
  1. Home
  2. Developers and admins
  3. Installation
  4. Update Xperience by Kentico projects

Update Xperience by Kentico projects


Was this page helpful?

Send us feedback Go back to top
  • Community Questions & Answers (opens in a new tab)
  • Contact support (opens in a new tab)

We recommend that you update your Xperience by Kentico projects regularly. Updates are released in the form of:

  • Hotfixes – weekly fixes of issues and reported security vulnerabilities. May include improvements that increase the system's security against potential threats.
  • Refreshes – more extensive updates that add new features, introduce changes, and fix issues. Refreshes are planned for every month, but the release schedule may vary depending on the features included in each refresh.

Check the Changelog for additional details, workarounds and instructions related to individual update versions.

In rare cases, Refreshes (only major version updates) may contain breaking changes to the codebase, typically for obsolete or infrequently-used code. Check the Breaking changes sections of the Changelog to see if your codebase or other important functionality is affected.

Update automation

While the instructions on this page can be followed and performed manually, it is also possible to automate all steps of the Xperience by Kentico update process using various types of automation tools, release management software, pipelines or scripts.

If you use an AI coding assistant that supports agent skills and plugins, the project lifecycle plugin⁠ (opens in a new tab) from KentiCopilot provides an update-xperience skill. The skill determines your current and target versions, reviews every Changelog entry in between together with the update guides they link to, and then follows the procedure described on this page. Review the resulting changes as you would with any other update.

Update process overview

Before updating

  • Create a backup of your Xperience database, project folder and the folder where you store assets (~/assets by default). In case of a failed update, use these backups to restore your environment to its original state to prevent inconsistent data.
  • When updating a development project with Continuous Integration enabled, familiarize yourself with the Update instructions for CI.
  • If your project includes admin UI translations, export the system resources as a baseline for comparison. See Update translations after an update.

Start by performing the update on a local development instance of your Xperience project:

  1. Update the project's Xperience NuGet packages.
  2. Update the project's database and files.

After you successfully test the update locally, you can apply the update to your Xperience application's production deployment. The following steps outline the general approach, but the exact process will depend on your deployment flow and hosting environment.

  1. Temporarily stop your production application (provide a suitable offline page) or prepare a staging deployment that you can later swap.
  2. Deploy the updated web project to your production or staging environment.
  3. Perform the database and file update for your production environment.
    • There are various ways to run the update command, depending on your deployment process and environment. For example, from a deployment pipeline, a local project with a "production" configuration that connects to the production database and file system, or if possible directly on the target environment.

    • For deployed applications containing built assemblies, run the following dotnet⁠ (opens in a new tab) command (replace the assembly with the name of your Xperience project's DLL):

      CMD
      dotnet myxperienceproject.dll --kxp-update

      To skip the database backup prompt in an automated environment, add the --skip-confirmation parameter to the update command.

      Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

      CMD
      dotnet myxperienceproject.dll --kxp-update --skip-confirmation

      Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

    • To confirm that the database version matches the deployed application before you relaunch, run the --kxp-db-status command. Automated pipelines can branch on the command's JSON output instead of parsing startup logs.

  4. Finalize the update (relaunch the stopped production application, swap your staging and production slots, etc.).
  5. If you use the Xperience project templates package, update your installed templates. See Update project templates.

Admin UI localization

If your project includes admin UI translations, review and update your localized resource files after each update. Xperience updates may modify system resource strings, which can make existing translations outdated. See How updates affect translations for possible impacts of system resource string changes, and Maintain translations across updates for a step-by-step procedure.

Update NuGet packages

To update your project's Xperience code libraries and administration, update all Kentico.Xperience.* NuGet packages installed in your solution to the same target version. Depending on your project, this includes:

  • Kentico.Xperience.WebApp
  • Kentico.Xperience.Admin
  • All installed extension packages (for example, Kentico.Xperience.ManagementApi)

Check all projects in your solution, not only the main web project. Kentico.Xperience packages may be installed in separate projects, like Kentico.Xperience.Core.Tests in test projects.

Visual Studio
  1. Open your application in Visual Studio.
  2. Right-click your website project in the Solution Explorer and select Manage NuGet Packages.
  3. On the Updates card, select all Kentico.Xperience NuGet packages and click Update.
  4. Repeat for every other project in the solution that references Kentico.Xperience packages.
  5. Rebuild the solution.
.NET CLI
  1. Open the command line prompt and navigate to the root folder of the project you want to update.

  2. List the currently installed packages to see which Kentico.Xperience packages the project references and which updates are available. Pass a solution file to cover all projects at once.

    CMD.NET CLI
    dotnet list package --outdated
    dotnet list Acme.sln package --outdated
  3. Run the dotnet add package⁠ (opens in a new tab) command for each installed Kentico.Xperience package.

    CMD.NET CLI
    dotnet add package Kentico.Xperience.WebApp
    dotnet add package Kentico.Xperience.Admin
    dotnet add package Kentico.Xperience.ImageProcessing
    dotnet add package Kentico.Xperience.ManagementApi
  4. Repeat for every other project in the solution that references Kentico.Xperience packages.

    CMD.NET CLI
    # Sets the project path before the 'package' argument
    dotnet add ..\Acme.Web.Tests\Acme.Web.Tests.csproj package Kentico.Xperience.Core.Tests
  5. Rebuild the solution.

    CMD.NET CLI
    dotnet build

Target update version

We strongly recommend updating to the latest available version of Xperience. However, if you wish to update to a specific version, you can select it in Visual Studio's NuGet Package Manager interface or specify it when running the dotnet add package⁠ (opens in a new tab) command.

The application will not start until the NuGet package version matches your database version. To check whether the database needs an update without starting the application, run the --kxp-db-status command. Continue by updating your project's database and files.

Update data and files

After updating your project's NuGet packages, update the database and file system using the .NET command-line interface (CLI). This update always targets the new version of the project's NuGet packages.

  1. Shut down your Xperience application if it is running and receives traffic.

  2. Open the command line prompt.

  3. Navigate to the root folder of the project you want to update.

  4. Run the following command:

    CMD
    dotnet run --no-build -- --kxp-update

    Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

    CMD
    dotnet run --no-build -- --kxp-update --skip-confirmation

    The update asks you to confirm that the database is backed up. With no interactive console attached, the prompt cannot be answered and the command fails instead of updating anything, with System.InvalidOperationException: Cannot read keys when either application does not have a console or when console input has been redirected. Try Console.Read.

    Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

    Command details

    If updating a deployed application containing built assemblies, use the dotnet myxperienceproject.dll --kxp-update command instead (replace the assembly with the name of your Xperience project's DLL). For more information, see the dotnet run documentation⁠ (opens in a new tab).

    Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

    If updating a deployed application containing built assemblies, use the dotnet myxperienceproject.dll --kxp-update --skip-confirmation command instead (replace the assembly with the name of your Xperience project's DLL). For more information, see the dotnet run documentation⁠ (opens in a new tab).

    Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

    When updating a full project locally, add the --no-build parameter to the dotnet run command if you have already rebuilt your project after updating the NuGet packages. This option saves time and avoids another unnecessary project build before the update. To prevent errors after building the project with a configuration other than Debug mode, set the --property:Configuration parameter to the desired value.

    Add the -- syntax separator before any command parameters that you wish to pass directly to the Xperience application (--kxp-update). This prevents conflicts with general .NET CLI parameters, for example when using the --help option.

    If you wish to skip the database backup prompt when running the update command (e.g., in an automated environment), add the --skip-confirmation parameter. For example:

    dotnet run -- --kxp-update --skip-confirmation

The command updates the project's database and in certain cases assets or folders on the file system (using SQL scripts and API operations). The database version now matches the version of the project's Xperience NuGet packages.

The update process does not automatically start the application when finished. To verify the result, run the --kxp-db-status command – the command now reports the Ready state. After the update, you can run the application again using the dotnet run command, or another suitable approach depending on your hosting environment.

Update projects in the SaaS environment

Xperience by Kentico applications deployed to the SaaS environment need to be updated manually. Use the following process:

  1. Update your project in a local development environment to the desired version.
    • See Update NuGet packages and Update data and files.
  2. Create a new deployment package.
    • Update the $CDRepository/repository.config file according to your Continuous Deployment object filtering requirements. If you use the <IncludedObjectTypes> element, check the New object types for CI/CD section of the changelog for any new object types introduced by the update.
  3. Redeploy the package to your Xperience Portal project.

The deployment process automatically ensures that the database in the SaaS environment is up-to-date.

Update development projects with Continuous Integration

If you are updating a development project with Continuous Integration enabled:

  • Before running the update, disable CI (via dotnet run --no-build -- --kxp-ci-disable or the Xperience administration settings).
  • Apply the update separately for each instance in your development environment. You cannot fully synchronize the database update using your source control system and CI.
  • If you use the <IncludedObjectTypes> element in your CI repository.config file to filter object types, check the New object types for CI/CD section of the changelog for any new object types introduced by the update. Add any new object types that you wish to include in CI.
  • After updating, every developer needs to run complete serialization for all objects to recreate the content of the CIRepository folder on their instance (use the --kxp-ci-store CLI command).
  • After one developer commits the update changes to the source control, other developers CANNOT commit or load changes until they apply the update to their own instance.

Example – Update process with CI

The following steps show an example of the update process for a local development instance using Continuous Integration (suitable for an automated script, AI workflows, etc.).

  1. Commit all pending changes under the CI repository to your source control.

  2. Create a backup of your Xperience database and project folder.

  3. Shut down the Xperience application, and any other applications that connect to the same database.

  4. Disable CI.

    CMD.NET CLI
    dotnet run --no-build -- --kxp-ci-disable
  5. Update the project's NuGet packages.

  6. Update project data.

    CMD.NET CLI
    dotnet run --no-build -- --kxp-update

    Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

    CMD.NET CLI
    dotnet run --no-build -- --kxp-update --skip-confirmation

    Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

  7. Re-enable CI.

    CMD.NET CLI
    dotnet run --no-build -- --kxp-ci-enable
  8. Serialize all objects to the CIRepository folder.

    CMD.NET CLI
    dotnet run --no-build -- --kxp-ci-store
  9. Commit the update changes to your source control.

Update the Management MCP

If your project uses the Management MCP server, you also need to make sure that the following packages are up-to-date:

  • Kentico.Xperience.ManagementApi⁠ (opens in a new tab) NuGet package
    • Update this package together with your other Xperience packages.
    CMD.NET CLI
    dotnet add package Kentico.Xperience.ManagementApi
  • @kentico/management-api-mcp⁠ (opens in a new tab) npm package
    • We recommend using the @kentico/management-api-mcp@latest argument in your MCP server configuration. This ensures that the latest version of the package is installed automatically when the server starts.
    • You do not need to match the npm package version to your project's Xperience NuGet packages. The MCP server reads the management API schema from your running project, so the latest version also works with older Xperience versions.

Restart the MCP server after the update so that it loads any changes to the management API.

Update admin customization projects

If you have one or more projects for custom administration development, remember to perform the following when updating to a newer Xperience by Kentico version:

  • Update the Xperience by Kentico NuGet packages installed in the custom admin back-end project.

  • Update the dependencies of your custom admin client project – @kentico/xperience-admin-base, @kentico/xperience-admin-components, @kentico/xperience-webpack-config, etc. Use the npm-update⁠ (opens in a new tab) command:

    CMD
    # Switches to the directory containing client module code
    cd ..\Acme.Web.Admin\Client
    npm update

Update project templates

If you have installed the Xperience project templates package on your machine, we recommend keeping the templates up-to-date. This is required if you wish to create new projects that include released features and fixes.

To update the Xperience project templates, open the command line and run:

CMDUpdate project templates
dotnet new update

On this page

  • Update process overview
    • Update NuGet packages
    • Update data and files
  • Update projects in the SaaS environment
  • Update development projects with Continuous Integration
    • Example – Update process with CI
  • Update the Management MCP
  • Update admin customization projects
  • Update project templates