The `devexpress-dashboard-cli` package provides command-line interface tools specifically designed to streamline development with DevExpress Dashboards. Its primary functions include building custom themes for the Web Dashboard using metadata from the DevExtreme ThemeBuilder and generating new application projects that integrate DevExpress Dashboard controls. The current stable version is 25.2.6, aligning with DevExpress's consistent twice-per-year major release cadence. This CLI is an essential tool for developers working within the DevExpress ecosystem, enabling automated theme generation and project setup, differentiating it from generic CLIs by its deep integration with DevExpress components and design patterns. It handles the conversion of customized DevExtreme ThemeBuilder resource files into Web Dashboard themes and assists in the initial scaffolding of DevExpress-enabled applications, particularly in client-server architectures like Angular with ASP.NET Core backends.
npm install devexpress-dashboard-cliVerified import paths — ran on the pinned version, not inferred.
Demonstrates how to install the CLI's peer dependencies and use the `build-theme` command to generate a custom CSS theme file from metadata.
Ensure all DevExpress-related packages in your `package.json` (e.g., `devexpress-dashboard`, `devextreme`, `@devexpress/analytics-core`) and server-side components explicitly specify the exact same version (e.g., `25.2.6`). Use `npm install --save-exact` or update `package.json` manually and reinstall.
Manually install all peer dependencies listed in the `package.json` for `devexpress-dashboard-cli` (e.g., `devexpress-dashboard`, `devextreme-themebuilder`, `@devexpress/analytics-core`, `@devexpress/analytics-core-cli`) using `npm install <package-name>@<version> --save-exact`.
Always use the latest stable version of `devexpress-dashboard-cli` (currently 25.2.6) and regularly run `npm audit` to check for and address any reported vulnerabilities in direct or transient dependencies. Update affected packages if fixes are available.
For testing environments (e.g., Jest), configure your test runner to correctly handle ECMAScript Modules (ESM) that DevExtreme packages (or their dependencies like `@preact/signals-core`) might ship. This often involves transforming ESM to CommonJS for Jest or updating Jest's module resolution. Consult DevExtreme/Angular documentation for specific setup guides.
When developing a Web Dashboard application, ensure you also set up a compatible DevExpress Dashboard backend project using ASP.NET Core or ASP.NET MVC. The client-side dashboard generated or themed by the CLI will communicate with this backend for data operations.
Configure your DevExpress NuGet Feed as a package source. First, obtain your personal NuGet feed URL from nuget.devexpress.com (requires a registered user account). Then, register it using `dotnet nuget add source <source-url> -n DevExpress` or enable it with `dotnet nuget enable source <source-name>` if it's already listed but disabled.
Configure Jest's `transformIgnorePatterns` to transpile DevExtreme and its ESM-only dependencies (e.g., `@preact/signals-core`) from ESM to CJS during testing. Alternatively, explore Jest presets for Angular that handle ESM modules or migrate to a test runner that natively supports ESM.
Verify the database connection string in your production environment. Ensure the identity under which your web application runs on the server has the necessary permissions to access the database. Check server firewalls and database security settings. Utilize server-side logging or DevExpress's `ASPxDashboard.ConnectionError` event and `HandleServerErrors` property to get detailed error information.