@n8n-as-code/agent-cli 0.2.0
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 +52 -0
- package/dist/assets/n8n-nodes-index.json +505297 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +82 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -0
- package/dist/services/ai-context-generator.d.ts +11 -0
- package/dist/services/ai-context-generator.d.ts.map +1 -0
- package/dist/services/ai-context-generator.js +101 -0
- package/dist/services/ai-context-generator.js.map +1 -0
- package/dist/services/node-schema-provider.d.ts +27 -0
- package/dist/services/node-schema-provider.d.ts.map +1 -0
- package/dist/services/node-schema-provider.js +92 -0
- package/dist/services/node-schema-provider.js.map +1 -0
- package/dist/services/snippet-generator.d.ts +7 -0
- package/dist/services/snippet-generator.d.ts.map +1 -0
- package/dist/services/snippet-generator.js +141 -0
- package/dist/services/snippet-generator.js.map +1 -0
- package/package.json +36 -0
- package/src/assets/n8n-nodes-index.json +505297 -0
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @n8n-as-code/agent-cli
|
|
2
|
+
|
|
3
|
+
Specialized tooling for AI Agents (Cursor, Cline, Copilot) to interact with n8n workflows and nodes.
|
|
4
|
+
|
|
5
|
+
## 🛠Purpose
|
|
6
|
+
|
|
7
|
+
This package provides a dedicated CLI (`n8n-agent`) and programmatic tools designed to:
|
|
8
|
+
1. **Provide Context**: Help AI agents understand n8n node structures.
|
|
9
|
+
2. **Search Nodes**: Find specific n8n nodes and their properties.
|
|
10
|
+
3. **Initialize Context**: Bootstrap developer environments with `AGENTS.md`, JSON schemas, and snippets.
|
|
11
|
+
|
|
12
|
+
## 🚀 Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install @n8n-as-code/agent-cli
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## 📖 CLI Usage
|
|
19
|
+
|
|
20
|
+
### `init-ai`
|
|
21
|
+
Generates the AI context files in your current workspace.
|
|
22
|
+
```bash
|
|
23
|
+
n8n-agent init-ai
|
|
24
|
+
```
|
|
25
|
+
Generates:
|
|
26
|
+
- `AGENTS.md`: Instructions for your AI agent.
|
|
27
|
+
- `n8n-schema.json`: Validation schema for workflows.
|
|
28
|
+
- `.vscode/n8n.code-snippets`: Rich snippets for common nodes.
|
|
29
|
+
|
|
30
|
+
### `list`
|
|
31
|
+
Lists all available n8n nodes.
|
|
32
|
+
```bash
|
|
33
|
+
n8n-agent list
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `get <nodeName>`
|
|
37
|
+
Retrieves full details and schema for a specific node.
|
|
38
|
+
```bash
|
|
39
|
+
n8n-agent get n8n-nodes-base.httpRequest
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### `search <query>`
|
|
43
|
+
Searches for nodes matching a query.
|
|
44
|
+
```bash
|
|
45
|
+
n8n-agent search "google sheets"
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## 🧩 Integration with VS Code
|
|
49
|
+
This package is a core dependency of the `n8n-as-code` VS Code extension, powering its AI features and node indexing.
|
|
50
|
+
|
|
51
|
+
## 📄 License
|
|
52
|
+
MIT
|