Syncfusion® CLI in React
15 Oct 202610 minutes to read
The Syncfusion® CLI is a command-line tool that helps developers create, configure, and manage React projects with Syncfusion® React components. It simplifies project setup by enabling developers to scaffold React applications, add ready-to-use Syncfusion® React components, configure themes, set up Syncfusion® MCP assistants, install Syncfusion® component skills, manage Syncfusion accounts and licenses, and check for CLI updates.
For React development, the Syncfusion® CLI supports project creation with Vite and Next.js. By using the Syncfusion® CLI, developers can reduce manual configuration effort and quickly start building React projects with a recommended project structure, predefined templates, and the required component setup.
The
@syncfusion/syncfusion-clipackage has been deprecated to follow the standard package naming convention. Please use the latest@syncfusion/clipackage instead. Future updates and new features will be available only in@syncfusion/cli. Uninstall the older package and upgrade to the latest package.
Prerequisites
- Node.js 24+ (LTS recommended).
- A terminal, command prompt, or shell environment is available.
Key Benefits
- Project Scaffolding - Quickly create React projects with the required Syncfusion configuration and recommended project structure.
-
Component Templates - Start with ready-to-use React component templates such as
Grid,Chart,Scheduler,Gantt,File Manager,Diagram, andRich Text Editor,PDF Viewer,DOCX EditorandSpreadsheet Editor. -
Theme and Styling Configuration - Easily apply built-in themes such as
Material 3,Fluent 2,Bootstrap 5.3, andTailwind 3with CSS or SCSS support. - AI Assistant Integration - Configure MCP assistants and install Syncfusion® components Skills to improve AI-assisted React development.
- Project information: View environment and project details, review installed Syncfusion package information.
- Account and license management - Sign in to Syncfusion, download and activate license keys, and view installed licenses.
Installation
Install the Syncfusion® CLI globally from npm.
npm install -g @syncfusion/cliAfter installation, verify that the sf command is available.
sf --version
or
sf -vIf you have the previous
@syncfusion/syncfusion-clipackage installed, use thisnpm uninstall -g @syncfusion/syncfusion-clicommand to uninstall it before installing@syncfusion/clito avoid installation failures.
Interactive Mode
Interactive mode provides a guided command-line interface for accessing the main Syncfusion® CLI actions. It is useful for users who prefer a menu-driven experience instead of manually entering complete commands.
To start interactive mode, run the CLI without additional arguments.
sfThe interactive menu displays the available CLI actions grouped by category.
──────────────────────────────────────────────────────────────
Syncfusion CLI v1.0.0
──────────────────────────────────────────────────────────────
? What would you like to do? (Use arrow keys)
📦 PROJECT MANAGEMENT
> Create a new project sf new
Add component to an existing project sf add
Add theme to an existing project sf theme switch
Show environment & project information sf info
🤖 AI & SKILLS
Setup Model Context Protocol (MCP) sf mcp init
Add component skills to AI Agent sf skills install
🔑 LICENSE MANAGEMENT
Manage Syncfusion account and licenses sf license
ℹ️ HELP & EXIT
View help sf --help
Check for CLI updates sf upgrade
Exit Ctrl + CThe following options are available in interactive mode:
| Option | Description | Command |
|---|---|---|
| Create a new project | Creates a new React project using Syncfusion React components. | sf new |
| Add component to existing project | Adds a Syncfusion React component to an existing project. | sf add |
| Add themes to existing project | Applies or changes the theme in the current project. | sf theme switch |
| Setup MCP | Configures MCP assistant support for the current project. | sf mcp init |
| Install Component Skills | Installs Syncfusion component skills to improve AI-assisted development. | sf skills install |
| Manage Syncfusion account and licenses | Manages your Syncfusion account and licenses. | sf license |
| Show Project info | Displays environment and project information. | sf info |
| View help | Displays Syncfusion CLI help information. | sf --help |
| Check for CLI updates | Checks the installed and latest available Syncfusion CLI versions. | sf upgrade |
| Exit | Exits interactive mode. | Ctrl + C |
License management commands
Run sf license to open the license management menu. The menu provides the following account and license actions:
| Option | Description | Command |
|---|---|---|
| Sign in to Syncfusion | Authenticates your Syncfusion account and enables access to your license and subscriptions. | sf login |
| Sign out | Signs out of the currently authenticated Syncfusion account. | sf logout |
| Download license key | Use this command in your project to download the license key for the currently installed package version associated with your Syncfusion account. The downloaded license key is available in the syncfusion-license.txt file in your current project. |
sf license download |
| View installed licenses | Use this command in your project to view the license keys downloaded for the current project. | sf license view |
| Activate license | Activates the license key for the current project using the downloaded license in the syncfusion-license.txt file. |
sf license activate |
Non-Interactive Mode
Non-interactive mode allows you to run Syncfusion CLI commands directly from the terminal by passing options as flags. This mode does not show prompts and is useful for automation, scripts, and repeatable project creation.
Syntax
sf <command> [options]Example
The following example uses the new command to create a React Vite project with Syncfusion® React components using the Grid template and Material 3 theme.
sf new my-app --framework react --template grid.
Syncfusion CLI commands
The Syncfusion® CLI provides commands to create projects, add Syncfusion® components, configure the MCP server, install skills, manage themes and licenses, and inspect project information.
Project Creation Command
Create a new Syncfusion® project with the desired framework, project type, templates, themes, and other configuration options. The project creation commands help you quickly set up a development environment and start building applications with Syncfusion components.
new command
The new command creates a React project with Syncfusion® React components. You can use this command to specify the framework, build tool, project type, component template, theme, styling format, MCP assistant configuration, and component skills installation.
Syntax
sf new <project-name> --framework <framework> --project-type <projecttype> --type <type> --template <component> --theme <theme> --styling <styling> --mcp <editor> --skillsExample
The following command creates a React application using Vite with JavaScript, Grid template, Material 3 theme, CSS styling, Syncfusion® Code Studio MCP configuration, and skills installation.
sf new my-app --framework react --project-type vite --template grid --mcp code-studio --skillsOptions
The new command supports options for configuring the project during creation.
| Option | Description | Supported values |
|---|---|---|
--framework |
Specifies the application framework. |
react, angular, vue
|
--project-type |
Specifies the React project type used to create the application. |
vite, nextjs
|
--type |
Specifies the application language. |
js, ts
|
--template |
Specifies the starter template for the application. |
empty, grid, chart, scheduler, file-manager, gantt, diagram, rich-text-editor, pdf-viewer, docx-editor, spreadsheet-editor
|
--theme |
Specifies the Syncfusion® theme to configure in the application. |
material3, tailwind3, bootstrap5.3, fluent2
|
--styling |
Specifies the stylesheet format. |
css, scss
|
--mcp |
Configures Syncfusion® MCP assistant support for the selected development environment. |
all,code-studio, vs-studio, cursor,jetbrains
|
--skills |
Installs Syncfusion® components Skills during project creation. | No value required |
Note: For React applications, the
--project-typeoption supportsviteandnextjs.
Project-Specific Commands
The following commands must be run inside an existing Syncfusion® project directory.
Add component command
Use the add command to add a supported Syncfusion® component to an existing project.
Syntax
sf add <component>Examples:
sf add grid
sf add chart
sf add scheduler
sf add gantt
sf add filemanager
sf add diagram
sf add rich-text-editor
sf add pdf-viewer
sf add docx-editor
sf add spreadsheet-editorMCP configuration Command
Use the mcp init command to configure Syncfusion® MCP assistant support in an existing project.
sf mcp init code-studioSkills command
Use the skills install command to install Syncfusion® component skills in an existing project.
sf skills installTheme switch command
Use the theme switch command to change the Syncfusion® theme used in the project.
sf theme switch --tailwind3Project information command
Use the info command to display project and environment details.
sf infoDefault Values
When values are not provided, the Syncfusion CLI uses default values where applicable.
| Setting | Default value |
|---|---|
| Framework | react |
| React project type | vite |
| Language | js |
| Template | empty |
| Theme | material3 |
| Styling | css |
| MCP | no |
| Skills | no |
Check for CLI updates
Use the upgrade command to check the installed and latest available Syncfusion CLI versions.
sf upgradeIf the installed CLI version is outdated, the command displays the following command to upgrade to the latest version:
npm i -g @syncfusion/cliHelp
The --help option displays the list of available Syncfusion CLI commands, arguments, and options.
sf --helpFAQ
Which frameworks are supported?
The Syncfusion CLI supports React, Angular, and Vue applications.
Which project types are supported for React?
React applications support Vite and Next.js.
Can I create a project without interactive prompts?
Yes. Use flag mode mode to create projects non-interactively.
Can I add components after project creation?
Yes. Use the sf add <component> command to add supported Syncfusion® components to an existing project.
Can I change the theme after project creation?
Yes. Use the sf theme switch <themeName> command to switch themes.
Does the Syncfusion CLI support Syncfusion® MCP and Skills?
Yes. The CLI supports Syncfusion® MCP assistant configuration and Syncfusion® Components Skills installation.