ai-site-pilot 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
# ai-site-pilot
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/ai-site-pilot)
|
|
4
|
+
[](https://ko-fi.com/xBenJamminx)
|
|
5
|
+
|
|
3
6
|
AI chat widget that can **control and navigate your website**. Unlike typical chatbots that just answer questions, Site Pilot can take actions—scroll to sections, open modals, filter content, and more.
|
|
4
7
|
|
|
5
8
|
## Features
|
|
@@ -11,6 +14,28 @@ AI chat widget that can **control and navigate your website**. Unlike typical ch
|
|
|
11
14
|
- 📱 **Responsive** - Works on all screen sizes
|
|
12
15
|
- ⚡ **Vercel AI SDK** - Works with any LLM provider
|
|
13
16
|
|
|
17
|
+
## How It Works
|
|
18
|
+
|
|
19
|
+
The package provides the chat UI and streaming infrastructure. **You teach the AI about your specific site** through:
|
|
20
|
+
|
|
21
|
+
1. **System Prompt** - Tell the AI what sections, data, and features exist on your site
|
|
22
|
+
2. **Tool Definitions** - Define what actions the AI can take (filter, navigate, open modals)
|
|
23
|
+
3. **Client Handlers** - Write the code that actually executes those actions
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
User: "Show me your mobile apps"
|
|
27
|
+
↓
|
|
28
|
+
AI understands request
|
|
29
|
+
↓
|
|
30
|
+
AI calls filter_by_category("Mobile") tool
|
|
31
|
+
↓
|
|
32
|
+
Your handler receives the call
|
|
33
|
+
↓
|
|
34
|
+
Your code filters the UI
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
The AI doesn't automatically know your site structure—you teach it via the system prompt. See the [complete example](#teaching-the-ai-your-site) below.
|
|
38
|
+
|
|
14
39
|
## Installation
|
|
15
40
|
|
|
16
41
|
```bash
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ai-site-pilot",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "AI chat widget that can control and navigate your website. Full-stack solution with streaming, tool system, and polished UI.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -54,6 +54,10 @@
|
|
|
54
54
|
],
|
|
55
55
|
"author": "Ben.Builds",
|
|
56
56
|
"license": "MIT",
|
|
57
|
+
"funding": {
|
|
58
|
+
"type": "ko_fi",
|
|
59
|
+
"url": "https://ko-fi.com/xBenJamminx"
|
|
60
|
+
},
|
|
57
61
|
"repository": {
|
|
58
62
|
"type": "git",
|
|
59
63
|
"url": "https://github.com/xBenJamminx/ai-site-pilot"
|