You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[Smart Data Extraction](https://help.syncfusion.com/document-processing/data-extraction/overview)|[syncfusion-dotnet-smart-data-extraction](https://github.com/syncfusion/document-sdk-skills/tree/master/skills/syncfusion-dotnet-smart-data-extraction)|
25
24
## Prerequisites
26
25
27
26
Before installing Syncfusion<supstyle="font-size:70%">®</sup> Document SDK Skills, ensure the following tools are available on your machine:
28
27
29
28
-**[Node.js](https://nodejs.org/en)** (v18 or later) — Required to run `npx` commands for installing skills.
30
29
-**[.NET SDK](https://dotnet.microsoft.com/en-us/download)** (8.0 or later) — Required for CSX script execution (Mode 2).
31
30
-**[dotnet-script](https://github.com/dotnet-script/dotnet-script)** — Required for CSX script execution (Mode 2). Install it globally by running: `dotnet tool install -g dotnet-script`.
31
+
- A supported AI agent or IDE that integrates with the Skills CLI (VS Code, Syncfusion® Code Studio, Cursor, etc.)
32
32
33
33
## Installation
34
34
35
-
Choose one of the following commands to install Syncfusion<supstyle="font-size:70%">®</sup> Document SDK Skills based on your preference. You can also explore Syncfusion<supstyle="font-size:70%">®</sup> skills from the [marketplace](https://skills.sh/syncfusion/).
35
+
Choose one of the following commands to install [Syncfusion<supstyle="font-size:70%">®</sup> Document SDK Skills](https://github.com/syncfusion/document-sdk-skills) based on your preference. You can also explore Syncfusion<supstyle="font-size:70%">®</sup> skills from the [marketplace](https://skills.sh/syncfusion/).
36
36
37
37
To install all document SDK skills at once, use the following command:
This registers the Syncfusion<supstyle="font-size:70%">®</sup> skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills).
54
+
{% endhighlight %}
55
+
{% endtabs %}
50
56
51
-
To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
57
+
Choose and install skills interactively from the terminal:
52
58
53
-
## What's Included
59
+
{% tabs %}
60
+
{% highlight bash tabtitle="npm" %}
54
61
55
-
1.**Document SDK API Knowledge** — Curated, skill-based guidance for creating, editing, and converting PDF, Word, Excel, PowerPoint, and Markdown documents using Syncfusion<supstyle="font-size:70%">®</sup> Document SDK libraries. Covers key APIs, supported formats, and conversions.
56
-
2.**Dual-Mode Execution (.NET)** — Supports two operating modes:
57
-
-**Mode 1** — Generate production-ready code for your project.
58
-
-**Mode 2** — Execute a document task immediately via a CSX script without modifying your project.
59
-
3.**Patterns & Best Practices** — Practical recommendations for API usage, platform-specific NuGet package selection, and document processing workflows (for example, mail merge, PDF digital signatures, Excel pivot tables, and PowerPoint chart creation). All guidance is authored directly within the skill file rather than being fetched from external documentation.
62
+
npx skills add syncfusion/document-sdk-skills
60
63
64
+
{% endhighlight %}
65
+
{% endtabs %}
61
66
62
-
## How Syncfusion<supstyle="font-size:70%">®</sup> Document SDK Agent Skills Work
67
+
The terminal will show a list of available skills. Use the arrow keys to navigate, space bar to select the skills you want, and Enter to confirm.
63
68
64
-
1.**Read the relevant skill files and choose modes based on the user's query** The assistant retrieves library APIs, and code patterns from the installed Syncfusion<supstyle="font-size:70%">®</sup> Skills. It automatically chooses the appropriate operating mode based on the provided prompt.
65
-
2.**Enforces Syncfusion<supstyle="font-size:70%">®</sup> best practices**, including:
66
-
- Suggesting the correct NuGet packages or JAR files based on the detected application type.
67
-
- Using only APIs and code patterns explicitly present in the skill reference files.
68
-
- Configuring the Syncfusion<supstyle="font-size:70%">®</sup> license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable.
69
-
3.**Operates in two modes** based on the user's intent:
70
-
-**Mode 1 — Generate Code**: Produces production-ready code. No scripts are created or executed. Triggered by keywords such as `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, or `"example"`.
71
-
-**Mode 2 — Execute via CSX Script**: Creates a temporary `.csx` script, runs it with `dotnet script`, produces the output document file, then cleans up — without modifying the user's project. Triggered by keywords such as `"create"`, `"generate"`, `"make"`, `"open"`, `"edit"`, `"modify"`, or a file path (e.g., `output/report.docx`).
69
+
{% tabs %}
70
+
{% highlight bash tabtitle="npm" %}
71
+
72
+
Select skills to install (space to toggle)
73
+
│ ◻ syncfusion-dotnet-pdf
74
+
│ ◻ syncfusion-dotnet-word
75
+
│ ◻ syncfusion-dotnet-excel
76
+
│ ◻ syncfusion-dotnet-powerpoint
77
+
│ ◻ syncfusion-dotnet-markdown
78
+
│ ◻ syncfusion-dotnet-smart-data-extraction
79
+
│ ◻ syncfusion-java-word
80
+
│ ◻ syncfusion-flutter-pdf
81
+
│ ◻ syncfusion-javascript-pdf
82
+
│ .....
83
+
84
+
{% endhighlight %}
85
+
{% endtabs %}
86
+
87
+
Next, select which AI agent you're using and where to store the skills.
Choose your installation scope (project-level or global), then confirm to complete the installation.
72
109
73
-
## Using the AI Assistant
110
+
{% tabs %}
111
+
{% highlight bash tabtitle="npm" %}
112
+
113
+
◆ Installation scope
114
+
│ ● Project (Install in current directory (committed with your project))
115
+
│ ○ Global
116
+
117
+
◆ Proceed with installation?
118
+
│ ● Yes / ○ No
119
+
120
+
{% endhighlight %}
121
+
{% endtabs %}
122
+
123
+
This registers the Syncfusion<supstyle="font-size:70%">®</sup> skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills).
124
+
125
+
To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
126
+
127
+
## How Syncfusion<supstyle="font-size:70%">®</sup> Document SDK Agent Skills Work
128
+
129
+
1.**Read the relevant skill files and choose modes based on the user's query** The assistant retrieves library APIs, and code patterns from the installed Syncfusion<supstyle="font-size:70%">®</sup> Skills. It automatically chooses the appropriate operating mode based on the provided prompt.
130
+
131
+
2.**Operates in two modes** based on the user's intent:
132
+
-**Mode 1 — Generate Code**:
133
+
134
+
- Triggered when the prompt includes keywords such as `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, or `"example"`.
135
+
- Detects the application type and recommends the required NuGet packages.
136
+
- Generates production-ready code by referencing the appropriate `references/*.md` files for the requested functionalities.
137
+
-**Mode 2 — Execute via CSX Script**:
138
+
139
+
- Triggered when the prompt includes keywords such as `"create"`, `"generate"`, `"make"`, `"open"`, `"edit"`, `"modify"`, or when a file path is provided (e.g., `output/report.docx`).
140
+
- Creates a temporary `.csx` script by inserting the appropriate code snippet from the relevant `references/*.md` files.
141
+
- Executes the script using dotnet script and generates the output document.
142
+
- Performs cleanup by deleting the temporary `.csx` script.
143
+
144
+
3.**Register licensing key** Configuring the Syncfusion<supstyle="font-size:70%">®</sup> license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable.
145
+
146
+
### Using the AI Assistant
74
147
75
148
Once skills are installed, the assistant can generate Syncfusion<supstyle="font-size:70%">®</sup> document processing code or execute document generation tasks. Below are example prompts for each mode.
76
149
@@ -90,6 +163,74 @@ Once skills are installed, the assistant can generate Syncfusion<sup style="font
90
163
- "Create a 5-slide meeting agenda presentation and save it to output/agenda.pptx."
91
164
- "Extract data from the PDF at Input/invoice.pdf using Smart Data Extraction and save to output/data.json."
92
165
166
+
## Skills CLI Commands
167
+
168
+
After installation, manage Syncfusion<supstyle="font-size:70%">®</sup> Agent Skills using the following commands:
169
+
170
+
### List Skills
171
+
172
+
View all installed skills in your current project or global environment:
173
+
174
+
{% tabs %}
175
+
{% highlight bash tabtitle="NPM" %}
176
+
177
+
npx skills list
178
+
179
+
{% endhighlight %}
180
+
{% endtabs %}
181
+
182
+
### Remove a Skill
183
+
184
+
Uninstall a specific skill from your environment:
185
+
186
+
{% tabs %}
187
+
{% highlight bash tabtitle="NPM" %}
188
+
189
+
npx skills remove <skill-name>
190
+
191
+
{% endhighlight %}
192
+
{% endtabs %}
193
+
194
+
Replace `<skill-name>` with the name of the skill you want to remove (for example, `syncfusion-dotnet-pdf`).
195
+
196
+
### Check for Updates
197
+
198
+
Check if updates are available for your installed skills:
199
+
200
+
{% tabs %}
201
+
{% highlight bash tabtitle="NPM" %}
202
+
203
+
npx skills check
204
+
205
+
{% endhighlight %}
206
+
{% endtabs %}
207
+
208
+
### Update All Skills
209
+
210
+
Update all installed skills to their latest versions:
211
+
212
+
{% tabs %}
213
+
{% highlight bash tabtitle="NPM" %}
214
+
215
+
npx skills update
216
+
217
+
{% endhighlight %}
218
+
{% endtabs %}
219
+
220
+
## FAQ
221
+
222
+
**Which agents and IDEs are supported?**
223
+
224
+
Any Skills compatible agent or IDE that loads local skill files (Visual Studio Code, Cursor, CodeStudio, etc.).
225
+
226
+
**Are skills loaded automatically?**
227
+
228
+
Yes. Once installed, supported agents automatically detect and load relevant skills for Syncfusion‑related queries without requiring additional configuration.
229
+
230
+
**Skills are not being loaded**
231
+
232
+
Verify that skills are installed in the correct agent directory, restart the IDE, and confirm that the agent supports external skill files.
0 commit comments