@n8n-as-code/skills 0.16.6 → 0.16.8-next.0

package/README.md

@@ -2,22 +2,28 @@
 
 > **⚠️ BREAKING CHANGE (v0.16.0)**: Workflows are now generated and documented in **TypeScript format** (`.workflow.ts`) instead of JSON for better AI compatibility and readability.
 
+> **📌 Internal Library** — This package is not meant to be used directly. Public access is via [`n8nac`](https://www.npmjs.com/package/n8nac): `npx n8nac skills <command>`.
+
 Specialized tooling for AI Agents (Cursor, Cline, Copilot) to interact with n8n workflows and nodes.
 
 ## 🛠 Purpose
 
-This package provides a dedicated CLI (`n8nac-skills`) and programmatic tools designed to:
-1. **Provide Context**: Help AI agents understand n8n node structures.
-2. **Search Nodes**: Find specific n8n nodes and their properties.
-3. **Initialize Context**: Bootstrap developer environments with `AGENTS.md`, JSON schemas, and snippets.
+This package provides programmatic tools and the skills library consumed by `n8nac skills`. It:
+1. **Provides Context**: Helps AI agents understand n8n node structures.
+2. **Searches Nodes**: Finds specific n8n nodes and their properties.
+3. **Initializes Context**: Bootstraps developer environments with `AGENTS.md`, JSON schemas, and snippets.
+
+## Usage via `n8nac`
 
-## Installation
+All commands below are accessed through the `n8nac` CLI:
 
 ```bash
-npm install @n8n-as-code/skills
+npx n8nac skills --help
 ```
 
-## 📖 CLI Usage
+For installation: `npm install -g n8nac`
+
+## 📖 CLI Usage (`n8nac skills`)
 
 ### `search <query>` - Deep Unified Search (PRIMARY TOOL)
 
@@ -31,32 +37,32 @@ KEY FEATURES:
 
 ```bash
 # Search nodes, docs, and tutorials
-n8nac-skills search "how to generate images"
-n8nac-skills search "google sheets"
+n8nac skills search "how to generate images"
+n8nac skills search "google sheets"
 
 # Filter by type
-n8nac-skills search "authentication" --type documentation
-n8nac-skills search "database" --type node
+n8nac skills search "authentication" --type documentation
+n8nac skills search "database" --type node
 
 # Filter by category
-n8nac-skills search "ai" --category advanced-ai
+n8nac skills search "ai" --category advanced-ai
 ```
 
-### `get <nodeName>` - 📚 Complete Node Info
+### `node-info <nodeName>` - 📚 Complete Node Info
 Get full node information: schema + documentation + examples.
 
 ```bash
-n8nac-skills get googleSheets
-n8nac-skills get httpRequest
+n8nac skills node-info googleSheets
+n8nac skills node-info httpRequest
 ```
 
 **Includes hints for next steps!**
 
-### `schema <nodeName>` - ⚡ Quick Parameter Reference
+### `node-schema <nodeName>` - ⚡ Quick Parameter Reference
 Fast access to technical schema (parameters only).
 
 ```bash
-n8nac-skills schema googleSheets
+n8nac skills node-schema googleSheets
 # Returns only properties and required fields
 ```
 
@@ -65,58 +71,58 @@ Read full documentation pages. Use `search` first to find relevant titles.
 
 ```bash
 # Read a specific page
-n8nac-skills docs "Google Gemini"
-n8nac-skills docs "Expressions"
+n8nac skills docs "Google Gemini"
+n8nac skills docs "Expressions"
 
 # List categories or stats
-n8nac-skills docs --list
+n8nac skills docs --list
 ```
 
 ### `guides [query]` - 🎯 Find Guides
 Find workflow guides, tutorials, and walkthroughs.
 
 ```bash
-n8nac-skills guides "email automation"
-n8nac-skills guides "ai workflow"
-n8nac-skills guides --list
+n8nac skills guides "email automation"
+n8nac skills guides "ai workflow"
+n8nac skills guides --list
 ```
 
-### `workflows` - 🌐 Search & Download Community Workflows
+### `examples` - 🌐 Search & Download Community Workflows
 Search and download workflows from the **n8nworkflows.xyz** community repository (7000+ workflows).
 
-#### `workflows search <query>`
+#### `examples search <query>`
 Search workflows using FlexSearch for high-relevance results.
 
 ```bash
-n8nac-skills workflows search "slack notification"
-n8nac-skills workflows search "AI chatbot telegram"
-n8nac-skills workflows search "invoice processing" --limit 20
-n8nac-skills workflows search "google sheets" --json
+n8nac skills examples search "slack notification"
+n8nac skills examples search "AI chatbot telegram"
+n8nac skills examples search "invoice processing" --limit 20
+n8nac skills examples search "google sheets" --json
 ```
 
-#### `workflows info <id>`
+#### `examples info <id>`
 Display detailed information about a specific workflow.
 
 ```bash
-n8nac-skills workflows info 916
+n8nac skills examples info 916
 # Shows: name, author, tags, download URL
 ```
 
-#### `workflows install <id>`
-Download a workflow JSON file.
+#### `examples download <id>`
+Download a workflow TypeScript file.
 
 ```bash
-n8nac-skills workflows install 916
-n8nac-skills workflows install 4365 --output my-chatbot.json
-n8nac-skills workflows install 8088 --force  # Overwrite existing
+n8nac skills examples download 916
+n8nac skills examples download 4365 --output my-chatbot.workflow.ts
+n8nac skills examples download 8088 --force  # Overwrite existing
 ```
 
-#### `workflows list`
+#### `examples list`
 List available workflows (newest first).
 
 ```bash
-n8nac-skills workflows list
-n8nac-skills workflows list --limit 50
+n8nac skills examples list
+n8nac skills examples list --limit 50
 ```
 
 **Features:**
@@ -129,10 +135,10 @@ n8nac-skills workflows list --limit 50
 Find related nodes and documentation.
 
 ```bash
-n8nac-skills related googleSheets
+n8nac skills related googleSheets
 # Returns: Google Drive, Excel, Airtable, related docs
 
-n8nac-skills related "ai agents"
+n8nac skills related "ai agents"
 # Returns: AI-related concepts, nodes, examples
 ```
 
@@ -141,29 +147,31 @@ List available nodes and documentation categories.
 
 ```bash
 # Summary of nodes and docs
-n8nac-skills list
+n8nac skills list
 
 # List all node names
-n8nac-skills list --nodes
+n8nac skills list --nodes
 
 # List all doc categories
-n8nac-skills list --docs
+n8nac skills list --docs
 ```
 
 ### `validate <file>` - ✅ Validate Workflows
-Validate workflow JSON files.
+Validate workflow TypeScript files.
 
 ```bash
-n8nac-skills validate workflow.json
-n8nac-skills validate workflow.json --strict
+n8nac skills validate workflow.workflow.ts
+n8nac skills validate workflow.workflow.ts --strict
 ```
 
 ### `update-ai` - 🤖 Update AI Context
 Update AI Context (AGENTS.md, rule files, snippets).
 
 ```bash
-n8nac-skills update-ai
-n8nac-skills update-ai --version 1.70.0
+n8nac skills update-ai
+n8nac skills update-ai --version 1.70.0
+# Also available as:
+n8nac update-ai
 ```
 
 ## 📁 Data Source
@@ -176,11 +184,11 @@ The Skills CLI uses a pre-generated index of n8n nodes from the official n8n sou
 
 ## 🧩 Integration
 
-### With @n8n-as-code/cli
-The main CLI package (`@n8n-as-code/cli`) uses this package internally for its `init-ai` / `update-ai` commands to generate AI context files.
+### With `n8nac`
+The main CLI package (`n8nac`) depends on this package and exposes all commands under the `n8nac skills` subgroup. Users don't need to install `@n8n-as-code/skills` directly.
 
 ### With VS Code Extension
-This package is a sync dependency of the `n8n-as-code` VS Code extension, powering its AI features and node indexing.
+This package is a dependency of the `n8n-as-code` VS Code extension, powering its AI features and node indexing via the TypeScript API (`AiContextGenerator`, `SnippetGenerator`).
 
 ## 📄 License
 MIT