# Syncfusion CLI for agents

Source: https://ai.syncfusion.com/cli.md
Canonical: https://ai.syncfusion.com/cli.md
Entry-point: https://ai.syncfusion.com/llms.txt
Package: `@syncfusion/syncfusion-cli` on npm
Binary: `sf`
License-posture: Installing the CLI requires no license. Projects it creates use Syncfusion libraries, which require a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md

> The CLI scaffolds Syncfusion projects, adds components to existing ones, manages themes, and can
> configure MCP and install skills. Use it when the task is "create a new Syncfusion app"; do not use
> it to modify an existing project's structure without the user's agreement.

## Install

```bash
npm install -g @syncfusion/syncfusion-cli
```

The binary is `sf`, not `syncfusion`.

## Create a project

Non-interactive, which is what an agent should prefer:

```bash
sf new my-app --framework react --template grid
```

Interactive, when the framework or template is genuinely unknown:

```bash
sf
```

Frameworks supported: React, Angular, Vue.

## What the CLI can do

| Capability | Notes |
| --- | --- |
| Create a project from a preconfigured template | React, Angular, Vue |
| Add a component to an existing project | `sf add <component>` — choose from available React templates such as Grid, Chart, Scheduler, Gantt, File Manager, Diagram, Rich Text Editor, PDF Viewer, DOCX Editor, and Spreadsheet Editor |
| Theme management | Material 3, Tailwind 3, Fluent 2, Bootstrap 5.3 |
| Configure MCP | Writes editor MCP configuration |
| Install agent skills | Wraps the skills installer |
| Project info | Reports the Syncfusion packages and versions in use |

The exact subcommand names for MCP configuration and skill installation were not published at the
time of writing. Run `sf --help` and read the output rather than guessing. The documented direct paths
always work:

```bash
npx skills add syncfusion/react-ui-components-skills      # skills
```

MCP configuration: https://ai.syncfusion.com/mcp/llms.txt

## Rules for agents using the CLI

- **`sf new` creates files and directories.** Confirm the target directory with the user before
  running it, and never run it inside a repository that already has an application at that path.
- **Prefer the non-interactive form.** An interactive prompt in a non-interactive shell will hang.
- **Do not use the CLI to restructure an existing project.** Adding a component to a project the
  user already owns changes their dependency tree; say what it will do first.
- **The CLI does not handle licensing.** A scaffolded project still needs license registration. See
  the platform index for where registration goes.
- **Verify after scaffolding.** Run the project's build and confirm the template renders before
  reporting success.

## After scaffolding

1. Read the platform index for the framework you scaffolded:
   `https://ai.syncfusion.com/<platform-slug>/llms.txt`
2. Install the skill pack it names.
3. Register the license per that index.
4. Build and render before reporting success.

Sources: https://help.syncfusion.com/grid-sdk/react/data-grid/getting-started#install-the-syncfusion-cli
and https://www.syncfusion.com/blogs/post/syncfusion-cli-app-development