diff --git a/content/en/docs/02.getting-started.md b/content/en/docs/02.getting-started.md index d5bd4f2..149e6d9 100644 --- a/content/en/docs/02.getting-started.md +++ b/content/en/docs/02.getting-started.md @@ -29,13 +29,13 @@ If TypeScript is your preferred choice, make sure you have TypeScript version 4. ## AI Assistance {#ai-assistance} -Get intelligent, context-aware help in your AI-powered IDE. Use your IDE's agent or command execution feature (available in Cursor, GitHub Copilot Chat, Windsurf, and similar tools) and simply ask your AI assistant: +Get intelligent help in your AI-powered IDE when working with Rete.js. Use your IDE's agent or command execution feature (available in Cursor, GitHub Copilot Chat, and similar tools) and simply ask your AI assistant: ```prompt -Run npx rete-kit ai for [your intention] +Run npx rete-kit@latest ai ``` -Replace `[your intention]` with your actual goal, such as "learning Rete.js", "creating a new app", or "adding to my existing project". The AI agent will automatically determine the right options based on your intent. This generates IDE-specific instructions that help AI assistants understand Rete.js patterns and provide relevant guidance. +Run it once per project — this starts a short agent-driven setup for Rete.js AI guidance. Ask anything afterward about learning, building, or extending Rete.js. For more details, see the [AI Assistance](/docs/development/ai-assistance) documentation. diff --git a/content/en/docs/20.development/1.index.md b/content/en/docs/20.development/1.index.md index 03e7d4b..004470b 100644 --- a/content/en/docs/20.development/1.index.md +++ b/content/en/docs/20.development/1.index.md @@ -21,7 +21,7 @@ Check out the [Rete Kit](/docs/development/rete-kit) article for details. ## AI Assistance {#ai-assistance} -Enhance your Rete.js development workflow with AI-powered coding assistants. Get context-aware help for learning, creating applications, or developing plugins. +Enhance your Rete.js development workflow with AI-powered coding assistants. Get AI help for learning, creating applications, or developing plugins. Check out the [AI Assistance](/docs/development/ai-assistance) article for details. diff --git a/content/en/docs/20.development/3.rete-kit.md b/content/en/docs/20.development/3.rete-kit.md index f0cb61b..32b8ac2 100644 --- a/content/en/docs/20.development/3.rete-kit.md +++ b/content/en/docs/20.development/3.rete-kit.md @@ -26,7 +26,7 @@ It offers the following features: - **Plugin creating**: use this feature to create a basic plugin structure instantly, without the need for setting up a build system, linter, or test runner - **Application creation**: choose the framework to build your application, specify the version and desired features and get a ready-to-use application to jumpstart your development process - **Batch build**: select copies of repositories containing the source code of the plugins being developed and this tool will start building them in a watch mode, as well as synchronizing their dependencies -- **AI assistance**: generate context-aware instructions for AI-powered code editors to get intelligent help when learning or developing with Rete.js. See the [AI Assistance](/docs/development/ai-assistance/rete-kit-ai) documentation for details +- **AI assistance**: set up Rete.js AI guidance for AI-powered code editors. See the [AI Assistance](/docs/development/ai-assistance/rete-kit-ai) documentation for details ## Install {#install-rete-kit} @@ -103,17 +103,17 @@ Please note that to use the hot reload feature to its fullest, you will need to ## AI assistance {#ai-assistance-rete-kit} -Generate context-aware instructions for AI-powered code editors (Cursor, GitHub Copilot, Windsurf, etc.) to get intelligent help when learning or developing with Rete.js. Use your IDE's agent or command execution feature and simply ask your AI assistant: +Set up Rete.js AI guidance for AI-powered code editors (Cursor, GitHub Copilot, and others). Use your IDE's agent or command execution feature and simply ask your AI assistant: ```prompt -Run npx rete-kit ai for [your intention] +Run npx rete-kit@latest ai ``` -Replace `[your intention]` with your actual goal, such as "learning Rete.js", "creating a new app", or "adding to my existing project". The AI agent will automatically determine the right options based on your intent. +Run it once per project — this starts an agent-driven setup; your assistant finishes install and cleanup. Different tasks (learning, scaffolding, integration, plugins) are handled afterward in chat, not via separate command runs. See the [AI Assistance](/docs/development/ai-assistance/rete-kit-ai) documentation for complete details. ## Related Documentation {#related-documentation} -- [AI Assistance](/docs/development/ai-assistance) - Generate context-aware instructions for AI-powered code editors +- [AI Assistance](/docs/development/ai-assistance) - Set up Rete.js AI guidance for AI-powered code editors - [Rete CLI](/docs/development/rete-cli) - Build tool for plugin development diff --git a/content/en/docs/20.development/4.ai-assistance/1.index.md b/content/en/docs/20.development/4.ai-assistance/1.index.md index c15c224..8efbe6c 100644 --- a/content/en/docs/20.development/4.ai-assistance/1.index.md +++ b/content/en/docs/20.development/4.ai-assistance/1.index.md @@ -9,28 +9,28 @@ Enhance your Rete.js development workflow with AI-powered coding assistants. Thi ## Quick Start {#quick-start} -The fastest way to get AI assistance for Rete.js development is to use your AI-powered IDE's agent or command execution feature (available in Cursor, GitHub Copilot Chat, Windsurf, and similar tools). Simply ask your AI assistant: +The fastest way to get AI assistance for Rete.js development is to use your AI-powered IDE's agent or command execution feature (available in Cursor, GitHub Copilot Chat, and similar tools). Simply ask your AI assistant: ```prompt -Run npx rete-kit ai for [your intention] +Run npx rete-kit@latest ai ``` -Replace `[your intention]` with your actual goal, such as "learning Rete.js", "creating a new app", or "adding to my existing project". The AI agent will automatically determine the right tool and context options based on your description. This generates context-aware instructions for your IDE's AI assistant. +Run it once per project — this kicks off a short agent-driven setup (staging, install, cleanup). After that, describe what you need in plain language (learning, new app, integration, plugin work, and more). -For manual usage or more details, see the [Rete Kit AI](/docs/development/ai-assistance/rete-kit-ai) documentation. +For complete documentation, see [Rete Kit AI](/docs/development/ai-assistance/rete-kit-ai). ## Available Options {#available-options} ### Rete Kit AI {#rete-kit-ai} -**Best for:** Automated, context-aware IDE integration +**Best for:** Automated IDE setup with Rete.js-aware AI assistance -The `npx rete-kit ai` command (or `rete-kit ai` if installed globally) generates IDE-specific instruction files that provide contextually appropriate help based on your current situation: +The `npx rete-kit@latest ai` command (or `rete-kit ai` if installed globally) starts setup — your IDE agent stages, installs, and finalizes project instructions, task guides, and specialized agents. Later, when you ask for help, it adapts by task — for example: -- **Learning Rete.js** → `onboard` context -- **Creating new apps** → `boot` context -- **Working with existing code** → `dev` context -- **Plugin development** → `plugin` context +- **Learning Rete.js** → onboarding guidance +- **Creating new apps** → app scaffolding guidance +- **Working with existing code** → integration and customization guidance +- **Plugin development** → plugin development guidance Check out the [Rete Kit AI](/docs/development/ai-assistance/rete-kit-ai) guide for complete documentation. @@ -47,7 +47,7 @@ See the [LLMs.txt](/docs/development/ai-assistance/llms) guide for integration e ## Which Should I Use? {#which-should-i-use} -- **Use Rete Kit AI** if you want automated setup with context-aware instructions for your IDE +- **Use Rete Kit AI** if you want automated Rete.js AI setup in your IDE - **Use LLMs.txt** if you prefer manual integration or need to reference documentation in AI conversations Both approaches can be used together for comprehensive AI assistance. diff --git a/content/en/docs/20.development/4.ai-assistance/2.llms.md b/content/en/docs/20.development/4.ai-assistance/2.llms.md index 8ef5584..40eb52c 100644 --- a/content/en/docs/20.development/4.ai-assistance/2.llms.md +++ b/content/en/docs/20.development/4.ai-assistance/2.llms.md @@ -33,18 +33,18 @@ These endpoints are continuously updated to reflect the latest in node editor de You can integrate Rete.js documentation with any AI coding assistant by providing the LLMs.txt URLs as context. This gives the AI comprehensive knowledge about node editor development patterns and best practices. ::alert{type="info"} -[Rete Kit AI](/docs/development/ai-assistance/rete-kit-ai) automates this integration process by generating IDE-specific instruction files that reference LLMs.txt. If you're using Cursor, GitHub Copilot, Windsurf, or similar tools, consider using `npx rete-kit ai` for context-aware, automated setup. +[Rete Kit AI](/docs/development/ai-assistance/rete-kit-ai) automates this integration by installing project instructions and Rete.js guidance that reference LLMs.txt. If you're using Cursor, GitHub Copilot, or similar tools, consider `npx rete-kit@latest ai` for automated setup. :: ### Automated Setup with Rete Kit AI {#automated-setup-with-rete-kit-ai} -For automated IDE integration, use Rete Kit AI which generates context-aware instructions that reference LLMs.txt: +For automated IDE integration, ask your IDE's agent: -```bash -npx rete-kit ai --tool cursor --context onboard +```prompt +Run npx rete-kit@latest ai ``` -This creates IDE-specific instruction files that automatically include references to LLMs.txt endpoints. See the [Rete Kit AI](/docs/development/ai-assistance/rete-kit-ai) documentation for details. +This starts an agent-driven setup that installs project instructions and Rete.js guidance (including LLMs.txt references). See the [Rete Kit AI](/docs/development/ai-assistance/rete-kit-ai) documentation for details. ### Manual Integration {#manual-integration} diff --git a/content/en/docs/20.development/4.ai-assistance/3.rete-kit-ai.md b/content/en/docs/20.development/4.ai-assistance/3.rete-kit-ai.md index 966a88c..8f8f144 100644 --- a/content/en/docs/20.development/4.ai-assistance/3.rete-kit-ai.md +++ b/content/en/docs/20.development/4.ai-assistance/3.rete-kit-ai.md @@ -1,6 +1,6 @@ --- -description: Get intelligent, context-aware help in your AI-powered IDE with Rete Kit's AI command. Generate IDE-specific instructions for learning and developing with Rete.js -keywords: rete kit ai,ai assistance,cursor,windsurf,copilot,ide instructions,context-aware ai +description: Get intelligent help in your AI-powered IDE with Rete Kit's AI command. Set up project instructions and Rete.js-specific guidance for learning and developing with the framework +keywords: rete kit ai,ai assistance,cursor,copilot,ide instructions,rete.js development --- # Rete Kit AI @@ -9,105 +9,80 @@ keywords: rete kit ai,ai assistance,cursor,windsurf,copilot,ide instructions,con The AI command feature is currently **experimental**. The API and behavior may change in future versions. We welcome feedback and suggestions for improvement. Please share your experience on [GitHub Issues](https://github.com/retejs/rete-kit/issues). :: -Rete Kit includes an AI command that generates context-aware instructions for AI-powered code editors (Cursor, GitHub Copilot, Windsurf, etc.). These instructions help AI assistants understand your specific situation and provide more accurate, relevant help when learning or developing with Rete.js. +Rete Kit includes an AI command that prepares Rete.js-specific tooling for AI-powered code editors (Cursor, GitHub Copilot, Claude Code, and others). Your IDE's agent installs project instructions, task-specific guidance, and specialized agents so the assistant can give more accurate help when learning or developing with Rete.js. ## Quick Start {#quick-start} The fastest way to get started is to use your IDE's agent or command execution feature: ```prompt -Run npx rete-kit ai for [your intention] +Run npx rete-kit@latest ai ``` -Replace `[your intention]` with your actual goal (e.g., "learning Rete.js", "creating a new app", "adding to my existing project"). The AI agent will automatically determine the right tool and context options. +This starts an agent-driven setup process — usually in one session. The CLI stages a bundle; your IDE agent installs instructions and guidance, then cleans up staging. Run the command once per project (or again to refresh). Afterward, ask about learning, new apps, integration, plugins, and more. -Or specify options manually: - -```bash -npx rete-kit ai --tool --context [options] -``` - -**Options:** -- `--tool, -t ` - IDE tool (cursor, github, windsurf, etc.) -- `--context, -c ` - Context (onboard, boot, dev, plugin) -- `--force, -f` - Overwrite existing instruction files without confirmation -- `--interactive, -i` - Interactive mode to select options - -Run `npx rete-kit ai --help` for detailed usage information. - -## Contexts {#contexts} - -Choose the context that matches your situation: - -| Context | When to Use | Description | -|---------|-------------|-------------| -| **onboard** | Learning Rete.js fundamentals | Provides conceptual explanations, core building blocks (nodes, connections, sockets), processing models, and educational guidance. Use when asking "What is Rete.js?" or "How does visual programming work?" | -| **boot** | Creating a new Rete.js application | Provides step-by-step app creation guidance, framework selection help, feature recommendations, and project structure explanation. Helps with running `rete-kit app` commands and understanding project setup. | -| **dev** | Adding Rete.js to existing app or working with existing Rete.js app | Provides integration strategies, reference-driven patterns from Rete Kit apps, and problem-solving guidance. Helps with adding Rete.js to existing codebases, fixing issues, and adapting patterns to your architecture. | -| **plugin** | Developing, debugging, or customizing Rete.js plugins | Provides plugin architecture, signal processing patterns, debugging techniques, and advanced best practices. Helps with plugin structure, signal systems, testing, and cross-framework development. | - -## Supported Tools {#supported-tools} +## How It Works {#how-it-works} -| Tool | Status | Notes | -|------|--------|-------| -| Cursor | ✅ Supported | Generates `.mdc` files in `.cursor/rules/` directory | -| GitHub Copilot | ✅ Supported | Creates `.copilot-instructions.md` file in `.github/` directory | -| Windsurf | ⚠️ Included | Places `.md` files in `.windsurf/rules/` directory | -| Continue | ⚠️ Included | Places `.md` files in `.continue/rules/` directory | -| Amazon Q | ⚠️ Included | Places `.md` files in `.amazonq/rules/` directory | -| Antigravity | ⚠️ Included | Places `.md` files in `.agent/rules/` directory | -| Codex | ⚠️ Included | Creates `AGENTS.md` file in project root | -| Claude | ⚠️ Included | Creates `CLAUDE.md` file in project root | +Rete Kit AI is an **agent-driven** workflow spread across a few steps — not a single instant action. The CLI prepares a local bundle; your IDE's agent carries out install and cleanup. -**Status Legend:** -- ✅ **Supported** - Tested and verified to work correctly -- ⚠️ **Included** - Supported but not fully tested +1. **Prepare** — `npx rete-kit@latest ai` creates `.rete/` in your workspace: `.rete/ai/` (instructions, guides, agents to install) and `.rete/scripts/` (org tooling for ongoing use). Usually gitignored; re-running recreates the folder (`.rete/scripts/.env` preserved when present). -## Interactive Mode {#interactive-mode} +2. **Install** — The agent detects your IDE and installs instructions and guidance into IDE-specific paths (for example, `AGENTS.md` in Cursor, or Copilot instructions in VS Code). Project instructions are merged with any file you already have. -Not sure which context to use? Run interactive mode: +3. **Finalize** — The agent removes installed staging under `.rete/ai/` (how much depends on your IDE — often the whole folder; some tools keep agents or other fallback paths). `.rete/scripts/` always stays. Run `npx rete-kit@latest ai` again anytime to refresh from the latest rete-kit release. -```bash -npx rete-kit ai --interactive -``` +After setup, ask your assistant naturally — it selects the right guidance or agent based on your task, not a CLI flag. -## How It Works {#how-it-works} +## Guidance by Task {#guidance-by-task} -Rete Kit reads context-specific instruction templates from its package and transforms them for your IDE: +The setup includes guides for common Rete.js workflows. Your assistant uses them when your request matches: -1. **Reads templates** from `assets/ai/{context}/` (onboard, boot, dev, or plugin) -2. **Transforms content** for your IDE's format (e.g., `.mdc` files for Cursor) -3. **Writes instructions** to IDE-specific directories in your project -4. **Activates automatically** - Your IDE's AI assistant uses these instructions immediately +| Guide | When to use | What it covers | +|-------|-------------|----------------| +| **rete-onboard** | Learning Rete.js fundamentals | Concepts, nodes, connections, sockets, dataflow vs control flow | +| **rete-boot** | Creating a new Rete.js application | Stack selection, `rete-kit app`, project structure | +| **rete-dev** | Existing app or integration work | Adding Rete.js to a codebase, customization, debugging | +| **rete-plugin** | Plugin library development | Scope architecture, `rete-cli`, testing, PR workflow | -The generated instructions contain Rete.js-specific guidance tailored to your selected context. +Additional guides for org contributors: **rete-setup** (readonly org mirror), **rete-clone** (editable library copies), **rete-git** (branches and PRs), **rete-qa** (local and CI validation). -## Switching Contexts {#switching-contexts} +Specialized **agents** handle broader tasks: **rete-code-investigator** (cross-repo search) and **rete-package-reviewer** (package and PR review). -Switch contexts as your project evolves by running the command again with a different context. Use `--force` to overwrite existing instructions: +**Typical progression:** learning → new app → integration → plugin work — as your project evolves, describe the new goal in chat. No need to run `rete-kit ai` again for each phase. -```bash -npx rete-kit ai --tool cursor --context dev --force -``` +## Supported Tools {#supported-tools} -**Typical progression:** `onboard` → `boot` → `dev` → `plugin` +| Tool | Status | Notes | +|------|--------|-------| +| Cursor | ✅ Supported | Project `AGENTS.md`, `.cursor/skills/`, `.cursor/agents/` | +| GitHub Copilot (VS Code) | ✅ Supported | `.github/copilot-instructions.md` | +| Claude | ⚠️ Included | `CLAUDE.md` and IDE-native paths | +| Codex | ⚠️ Included | `AGENTS.md` | +| Antigravity | ⚠️ Included | Agent rules and project instructions | +| Devin Desktop | ⚠️ Included | IDE-native paths per tool prompt | +| Kiro | ⚠️ Included | IDE-native paths per tool prompt | +| OpenCode | ⚠️ Included | IDE-native paths per tool prompt | +| Pi | ⚠️ Included | IDE-native paths per tool prompt | + +**Status legend:** +- ✅ **Supported** — tested and verified to work correctly +- ⚠️ **Included** — supported but not fully tested ## Troubleshooting {#troubleshooting} -**Instructions not working?** -- Verify files were created in the correct directory (e.g., `.cursor/rules/` for Cursor) -- Try starting a new chat/agent session - instructions may need a new conversation to be loaded -- If a new session doesn't work, restart your IDE to ensure instructions are loaded -- Test by asking your IDE's AI assistant a Rete.js-specific question -- Regenerate with `--force` flag if needed +**AI assistance not working?** +- Verify project instructions were installed (e.g., `AGENTS.md` for Cursor, Copilot instructions for VS Code) +- Start a new chat or agent session — instructions may need a fresh conversation to load +- Restart your IDE if a new session does not help +- Ask a Rete.js-specific question to confirm the setup works (e.g., "How do I add a custom node?") +- Run `npx rete-kit@latest ai` again to refresh the bundle from the latest rete-kit release - Check IDE settings to ensure AI features are enabled -**Wrong context selected?** Regenerate with the correct context: -```bash -npx rete-kit ai --tool cursor --context --force -``` +**Wrong guidance for your task?** Describe your goal more clearly in a new message — the assistant picks guidance based on your request, not a fixed mode you selected upfront. + +**The `.rete/` folder** — local tooling, usually gitignored. `.rete/scripts/` stays for ongoing org work; `.rete/ai/` is install staging. Refresh overwrites edits — keep permanent changes in IDE instructions or project files. -**Interactive mode not working?** Use explicit `--tool` and `--context` flags instead (interactive mode requires a TTY). +**Upgrading from an older rete-kit?** `--context`, `--force`, and `--interactive` are no longer supported — setup is agent-driven instead. See the [rete-kit changelog](https://github.com/retejs/rete-kit/blob/main/CHANGELOG.md). ## Related Documentation {#related-documentation} diff --git a/content/uk/docs/02.getting-started.md b/content/uk/docs/02.getting-started.md index 2014cef..2530ec3 100644 --- a/content/uk/docs/02.getting-started.md +++ b/content/uk/docs/02.getting-started.md @@ -29,13 +29,13 @@ keywords: початок роботи,інсталяція,налаштуван ## ШІ-допомога {#ai-assistance} -Отримайте інтелектуальну, контекстно-орієнтовану допомогу у вашому редакторі коду з підтримкою ШІ. Використовуйте агента або функцію виконання команд вашого IDE (доступно в Cursor, GitHub Copilot Chat, Windsurf та подібних інструментах) і просто запитайте свого ШІ-асистента: +Отримайте розумну допомогу у IDE з підтримкою ШІ під час роботи з Rete.js. Використовуйте агента або функцію виконання команд вашого IDE (доступно в Cursor, GitHub Copilot Chat та подібних інструментах) і просто запитайте свого ШІ-асистента: ```prompt -Запусти npx rete-kit ai для [ваша мета] +Запусти npx rete-kit@latest ai ``` -Замініть `[ваша мета]` на вашу фактичну мету, наприклад "вивчення Rete.js", "створення нового додатку" або "додавання до мого існуючого проекту". ШІ-агент автоматично визначить правильні опції на основі вашого наміру. Це генерує специфічні для IDE інструкції, які допомагають ШІ-асистентам розуміти патерни Rete.js та надавати релевантні поради. +Запустіть один раз на проєкт — це запускає коротке налаштування Rete.js ШІ через агента. Далі запитуйте про вивчення, створення, розширення Rete.js. Для отримання детальної інформації див. документацію [ШІ-асистент](/uk/docs/development/ai-assistance). diff --git a/content/uk/docs/20.development/1.index.md b/content/uk/docs/20.development/1.index.md index 557e08a..8b1e3ff 100644 --- a/content/uk/docs/20.development/1.index.md +++ b/content/uk/docs/20.development/1.index.md @@ -21,7 +21,7 @@ Rete CLI — це інструмент розробки, який включає ## ШІ-асистент {#ai-assistance} -Покращте робочий процес розробки Rete.js за допомогою ШІ-асистентів для кодування. Отримайте контекстно-орієнтовану допомогу для вивчення, створення додатків або розробки плагінів. +Покращте робочий процес розробки Rete.js за допомогою ШІ-асистентів для кодування. Отримуйте ШІ-допомогу для вивчення, створення додатків або розробки плагінів. Перегляньте статтю [ШІ-асистент](/uk/docs/development/ai-assistance), щоб дізнатися більше. diff --git a/content/uk/docs/20.development/3.rete-kit.md b/content/uk/docs/20.development/3.rete-kit.md index 099f81a..57b7e42 100644 --- a/content/uk/docs/20.development/3.rete-kit.md +++ b/content/uk/docs/20.development/3.rete-kit.md @@ -26,7 +26,7 @@ keywords: розробка,kit,setup,bootstrap,react.js,vue.js,angular,svelte,li - **Створення плагіна**: скористайтеся цією функцією, щоб миттєво створити базову структуру плагіна, без необхідності налаштовування системи збірки, лінтера або тест-раннера - **Створення додатку**: виберіть фреймворк для створення додатку, вкажіть версію та бажані функції та отримайте готовий до використання додаток, щоб розпочати процес розробки - **Масова збірка**: виберіть копії репозиторіїв, що містять вихідний код плагінів, що розробляються, і цей інструмент почне їх збірку в режимі спостереження, а також синхронізує їхні залежності -- **ШІ-допомога**: генеруйте контекстно-орієнтовані інструкції для ШІ-редакторів коду, щоб отримати інтелектуальну допомогу під час вивчення або розробки з Rete.js. Див. документацію [ШІ-асистент](/uk/docs/development/ai-assistance/rete-kit-ai) для отримання детальної інформації +- **ШІ-допомога**: налаштуйте ШІ-керівництва Rete.js для редакторів коду з підтримкою ШІ. Див. документацію [ШІ-асистент](/uk/docs/development/ai-assistance/rete-kit-ai) для отримання детальної інформації ## Встановлення {#install-rete-kit} @@ -102,18 +102,18 @@ rete-kit build --folders my-plugin-1,my-plugin-1,my-project ## ШІ-допомога {#ai-assistance-rete-kit} -Генеруйте контекстно-орієнтовані інструкції для ШІ-редакторів коду (Cursor, GitHub Copilot, Windsurf тощо), щоб отримати інтелектуальну допомогу під час вивчення або розробки з Rete.js. Використовуйте агента або функцію виконання команд вашого IDE і просто запитайте свого ШІ-асистента: +Налаштуйте ШІ-керівництва Rete.js для редакторів коду з підтримкою ШІ (Cursor, GitHub Copilot та інші). Використовуйте агента або функцію виконання команд вашого IDE і просто запитайте свого ШІ-асистента: ```prompt -Запусти npx rete-kit ai для [ваша мета] +Запусти npx rete-kit@latest ai ``` -Замініть `[ваша мета]` на вашу фактичну мету, наприклад "вивчення Rete.js", "створення нового додатку" або "додавання до мого існуючого проекту". ШІ-агент автоматично визначить правильні опції на основі вашого наміру. +Запустіть один раз на проєкт — це запускає налаштування через агента; асистент завершує встановлення та очищення. Різні завдання (вивчення, scaffolding, інтеграція, плагіни) далі обробляються в чаті, а не окремими запусками команди. Див. документацію [ШІ-асистент](/uk/docs/development/ai-assistance/rete-kit-ai) для отримання повної інформації. ## Пов'язана документація {#related-documentation} -- [ШІ-асистент](/uk/docs/development/ai-assistance) - Генеруйте контекстно-орієнтовані інструкції для ШІ-редакторів коду +- [ШІ-асистент](/uk/docs/development/ai-assistance) - Налаштуйте ШІ-керівництва Rete.js для редакторів коду з підтримкою ШІ - [Rete CLI](/uk/docs/development/rete-cli) - Інструмент збірки для розробки плагінів diff --git a/content/uk/docs/20.development/4.ai-assistance/1.index.md b/content/uk/docs/20.development/4.ai-assistance/1.index.md index 34cedbd..a89927c 100644 --- a/content/uk/docs/20.development/4.ai-assistance/1.index.md +++ b/content/uk/docs/20.development/4.ai-assistance/1.index.md @@ -9,28 +9,28 @@ keywords: ai assistance, ai допомога, ші допомога, ai розр ## Швидкий старт {#quick-start} -Найшвидший спосіб отримати ШІ-допомогу для розробки Rete.js — використати агента або функцію виконання команд вашої IDE з підтримкою ШІ (доступно в Cursor, GitHub Copilot Chat, Windsurf та подібних інструментах). Просто запитайте свого ШІ-асистента: +Найшвидший спосіб отримати ШІ-допомогу для розробки Rete.js — використати агента або функцію виконання команд вашої IDE з підтримкою ШІ (доступно в Cursor, GitHub Copilot Chat та подібних інструментах). Просто запитайте свого ШІ-асистента: ```prompt -Запусти npx rete-kit ai для [ваша мета] +Запусти npx rete-kit@latest ai ``` -Замініть `[ваша мета]` на вашу фактичну мету, наприклад "вивчення Rete.js", "створення нового додатку" або "додавання до мого існуючого проекту". ШІ-агент автоматично визначить правильний інструмент та опції контексту на основі вашого опису. Це генерує контекстно-орієнтовані інструкції для ШІ-асистента вашого IDE. +Запустіть один раз на проєкт — це запускає коротке налаштування через агента (staging, встановлення, очищення). Далі описуйте потрібне простою мовою (вивчення, новий додаток, інтеграція, робота з плагінами тощо). -Для ручного використання або більш детальної інформації див. документацію [Rete Kit ШІ](/uk/docs/development/ai-assistance/rete-kit-ai). +Повну документацію див. у [Rete Kit ШІ](/uk/docs/development/ai-assistance/rete-kit-ai). ## Доступні опції {#available-options} ### Rete Kit ШІ {#rete-kit-ai} -**Найкраще для:** Автоматична, контекстно-орієнтована інтеграція з IDE +**Найкраще для:** Автоматичне налаштування IDE з ШІ-допомогою для Rete.js -Команда `npx rete-kit ai` (або `rete-kit ai` якщо встановлено глобально) генерує файли інструкцій, специфічні для IDE, які надають контекстно відповідну допомогу на основі вашої поточної ситуації: +Команда `npx rete-kit@latest ai` (або `rete-kit ai`, якщо встановлено глобально) запускає налаштування — агент IDE створює staging, встановлює та завершує налаштування інструкцій проєкту, керівництва за завданнями та спеціалізованих агентів. Пізніше, коли ви просите допомогу, він адаптується за завданням — наприклад: -- **Вивчення Rete.js** → контекст `onboard` -- **Створення нових додатків** → контекст `boot` -- **Робота з існуючим кодом** → контекст `dev` -- **Розробка плагінів** → контекст `plugin` +- **Вивчення Rete.js** → керівництво з onboarding +- **Створення нових додатків** → керівництво зі scaffolding +- **Робота з існуючим кодом** → керівництво з інтеграції та кастомізації +- **Розробка плагінів** → керівництво з розробки плагінів Перегляньте посібник [Rete Kit ШІ](/uk/docs/development/ai-assistance/rete-kit-ai) для повної документації. @@ -47,7 +47,7 @@ LLMs.txt надає документацію Rete.js у форматі, опти ## Що вибрати? {#which-should-i-use} -- **Використовуйте Rete Kit ШІ** якщо ви хочете автоматичне налаштування з контекстно-орієнтованими інструкціями для вашого IDE +- **Використовуйте Rete Kit ШІ** якщо ви хочете автоматичне налаштування ШІ для Rete.js у вашому IDE - **Використовуйте LLMs.txt** якщо ви віддаєте перевагу ручній інтеграції або вам потрібно посилатися на документацію в ШІ-розмовах Обидва підходи можна використовувати разом для комплексної ШІ-допомоги. diff --git a/content/uk/docs/20.development/4.ai-assistance/2.llms.md b/content/uk/docs/20.development/4.ai-assistance/2.llms.md index f06b390..2388e9c 100644 --- a/content/uk/docs/20.development/4.ai-assistance/2.llms.md +++ b/content/uk/docs/20.development/4.ai-assistance/2.llms.md @@ -24,7 +24,7 @@ keywords: llms.txt, візуальне програмування ші, реда Наша документація оптимізована для споживання ШІ через спеціалізовані кінцеві точки, які розуміють робочі процеси візуального програмування: - **[llms.txt](https://retejs.org/llms.txt)** - Основні концепції редакторів вузлів, основні API та патерни швидкого довідника -- **[llms-full.txt](https://retejs.org/llms-full.txt)** - Повна база знань візуального програмування, включаючи розширені патерни, архітектуру плагінів та обробні движки +- **[llms-full.txt](https://retejs.org/llms-full.txt)** - Повна база знань візуального програмування, включаючи розширені патерни, архітектуру плагінів та рушії обробки Ці кінцеві точки постійно оновлюються, щоб відображати останні практики розробки редакторів вузлів та можливості фреймворку. @@ -33,18 +33,18 @@ keywords: llms.txt, візуальне програмування ші, реда Ви можете інтегрувати документацію Rete.js з будь-яким ШІ-асистентом для кодування, надавши URL LLMs.txt як контекст. Це надає ШІ комплексні знання про патерни розробки редакторів вузлів та найкращі практики. ::alert{type="info"} -[Rete Kit ШІ](/uk/docs/development/ai-assistance/rete-kit-ai) автоматизує цей процес інтеграції, генеруючи файли інструкцій, специфічні для IDE, які посилаються на LLMs.txt. Якщо ви використовуєте Cursor, GitHub Copilot, Windsurf або подібні інструменти, розгляньте використання `npx rete-kit ai` для контекстно-орієнтованого автоматичного налаштування. +[Rete Kit ШІ](/uk/docs/development/ai-assistance/rete-kit-ai) автоматизує цю інтеграцію, встановлюючи інструкції проєкту та керівництва Rete.js з посиланнями на LLMs.txt. Якщо ви використовуєте Cursor, GitHub Copilot або подібні інструменти, розгляньте `npx rete-kit@latest ai` для автоматичного налаштування. :: ### Автоматичне налаштування з Rete Kit ШІ {#automated-setup-with-rete-kit-ai} -Для автоматичної інтеграції з IDE використовуйте Rete Kit ШІ, який генерує контекстно-орієнтовані інструкції, що посилаються на LLMs.txt: +Для автоматичної інтеграції з IDE запитайте агента вашого IDE: -```bash -npx rete-kit ai --tool cursor --context onboard +```prompt +Запусти npx rete-kit@latest ai ``` -Це створює файли інструкцій, специфічні для IDE, які автоматично включають посилання на кінцеві точки LLMs.txt. Див. документацію [Rete Kit ШІ](/uk/docs/development/ai-assistance/rete-kit-ai) для деталей. +Це запускає налаштування через агента з інструкціями проєкту та керівництвами Rete.js (включно з посиланнями на LLMs.txt). Див. документацію [Rete Kit ШІ](/uk/docs/development/ai-assistance/rete-kit-ai) для деталей. ### Ручна інтеграція {#manual-integration} diff --git a/content/uk/docs/20.development/4.ai-assistance/3.rete-kit-ai.md b/content/uk/docs/20.development/4.ai-assistance/3.rete-kit-ai.md index f9cec16..13dc24c 100644 --- a/content/uk/docs/20.development/4.ai-assistance/3.rete-kit-ai.md +++ b/content/uk/docs/20.development/4.ai-assistance/3.rete-kit-ai.md @@ -1,6 +1,6 @@ --- -description: Отримайте розумну, контекстно-орієнтовану допомогу у вашій IDE з підтримкою ШІ за допомогою команди ШІ Rete Kit. Генеруйте інструкції, специфічні для IDE, для вивчення та розробки з Rete.js -keywords: rete kit ai, ai допомога, ші допомога, cursor, windsurf, copilot, інструкції ide, ші-інструкції, контекстно-орієнтований ші +description: Отримайте розумну допомогу у IDE з підтримкою ШІ за допомогою команди Rete Kit AI. Налаштуйте інструкції проєкту та керівництва Rete.js для вивчення та розробки з фреймворком +keywords: rete kit ai, ai допомога, ші допомога, cursor, copilot, інструкції ide, розробка rete.js --- # Rete Kit ШІ @@ -9,105 +9,80 @@ keywords: rete kit ai, ai допомога, ші допомога, cursor, winds Функція ШІ-команди наразі є **експериментальною**. API та поведінка можуть змінитися в майбутніх версіях. Ми вітаємо відгуки та пропозиції щодо покращення. Будь ласка, поділіться своїм досвідом на [GitHub Issues](https://github.com/retejs/rete-kit/issues). :: -Rete Kit включає ШІ-команду, яка генерує контекстно-орієнтовані інструкції для IDE з підтримкою ШІ (Cursor, GitHub Copilot, Windsurf тощо). Ці інструкції допомагають ШІ-асистентам розуміти вашу конкретну ситуацію та надавати більш точну, релевантну допомогу під час вивчення або розробки з Rete.js. +Rete Kit включає ШІ-команду, яка готує інструменти Rete.js для IDE з підтримкою ШІ (Cursor, GitHub Copilot, Claude Code та інші). Агент вашого IDE встановлює інструкції проєкту, керівництва за завданнями та спеціалізованих агентів, щоб асистент точніше допомагав під час вивчення або розробки з Rete.js. ## Швидкий старт {#quick-start} Найшвидший спосіб почати — використати агента або функцію виконання команд вашого IDE: ```prompt -Запусти npx rete-kit ai для [ваша мета] +Запусти npx rete-kit@latest ai ``` -Замініть `[ваша мета]` на вашу фактичну мету (наприклад, "вивчення Rete.js", "створення нового додатку", "додавання до мого існуювого проекту"). ШІ-агент автоматично визначить правильний інструмент та опції контексту. +Це запускає процес налаштування через агента — зазвичай в одній сесії. CLI створює bundle; агент IDE встановлює інструкції та керівництва, потім очищує staging. Запустіть команду один раз на проєкт (або знову для оновлення). Далі запитуйте про вивчення, нові додатки, інтеграцію, плагіни тощо. -Або вкажіть опції вручну: - -```bash -npx rete-kit ai --tool --context [options] -``` - -**Опції:** -- `--tool, -t ` - Інструмент IDE (cursor, github, windsurf тощо) -- `--context, -c ` - Контекст (onboard, boot, dev, plugin) -- `--force, -f` - Перезаписати існуючі файли інструкцій без підтвердження -- `--interactive, -i` - Інтерактивний режим для вибору опцій - -Запустіть `npx rete-kit ai --help` для детальної інформації про використання. - -## Контексти {#contexts} +## Як це працює {#how-it-works} -Виберіть контекст, який відповідає вашій ситуації: +Rete Kit ШІ — **агентський** робочий процес із кількох кроків, а не миттєва дія. CLI готує локальний bundle; агент IDE виконує встановлення та очищення. -| Контекст | Коли використовувати | Опис | -|---------|-------------|-------------| -| **onboard** | Вивчення основ Rete.js | Надає концептуальні пояснення, основні будівельні блоки (вузли, з'єднання, сокети), моделі обробки та навчальні керівництва. Використовуйте, коли запитуєте "Що таке Rete.js?" або "Як працює візуальне програмування?" | -| **boot** | Створення нового додатку Rete.js | Надає покрокові керівництва зі створення додатку, допомогу з вибором фреймворку, рекомендації щодо функцій та пояснення структури проекту. Допомагає з запуском команд `rete-kit app` та розумінням налаштування проекту. | -| **dev** | Додавання Rete.js до існуючого додатку або робота з існуючим додатком Rete.js | Надає стратегії інтеграції, патерни на основі посилань з додатків Rete Kit та керівництва з вирішення проблем. Допомагає з додаванням Rete.js до існуючих кодової бази, виправленням проблем та адаптацією патернів до вашої архітектури. | -| **plugin** | Розробка, відлагодження або налаштування плагінів Rete.js | Надає архітектуру плагінів, патерни обробки сигналів, техніки відлагодження та розширені найкращі практики. Допомагає зі структурою плагінів, системами сигналів, тестуванням та розробкою для кількох фреймворків. | +1. **Підготовка** — `npx rete-kit@latest ai` створює `.rete/` у робочому просторі: `.rete/ai/` (інструкції, керівництва, агенти для встановлення) та `.rete/scripts/` (org-інструменти для подальшої роботи). Зазвичай додається до `.gitignore`; повторний запуск перестворює папку (`.rete/scripts/.env` зберігається, якщо вже є). -## Підтримувані інструменти {#supported-tools} +2. **Встановлення** — агент визначає ваш IDE і встановлює інструкції та керівництва у відповідні шляхи (наприклад, `AGENTS.md` у Cursor або інструкції Copilot у VS Code). Інструкції проєкту об'єднуються з наявним файлом, якщо він є. -| Інструмент | Статус | Примітки | -|------|--------|-------| -| Cursor | ✅ Підтримується | Генерує файли `.mdc` у директорії `.cursor/rules/` | -| GitHub Copilot | ✅ Підтримується | Створює файл `.copilot-instructions.md` у директорії `.github/` | -| Windsurf | ⚠️ Включено | Розміщує файли `.md` у директорії `.windsurf/rules/` | -| Continue | ⚠️ Включено | Розміщує файли `.md` у директорії `.continue/rules/` | -| Amazon Q | ⚠️ Включено | Розміщує файли `.md` у директорії `.amazonq/rules/` | -| Antigravity | ⚠️ Включено | Розміщує файли `.md` у директорії `.agent/rules/` | -| Codex | ⚠️ Включено | Створює файл `AGENTS.md` у корені проекту | -| Claude | ⚠️ Включено | Створює файл `CLAUDE.md` у корені проекту | +3. **Завершення** — агент видаляє встановлений staging у `.rete/ai/` (обсяг залежить від IDE — часто всю папку; деякі інструменти залишають агентів або інші fallback-шляхи). `.rete/scripts/` завжди лишається. Запустіть `npx rete-kit@latest ai` знову, щоб оновити bundle з останнього релізу rete-kit. -**Легенда статусу:** -- ✅ **Підтримується** - Протестовано та перевірено на правильну роботу -- ⚠️ **Включено** - Підтримується, але не повністю протестовано +Після налаштування пишіть асистенту природно — він обирає потрібне керівництво або агента за вашим завданням, а не за прапорцем CLI. -## Інтерактивний режим {#interactive-mode} +## Керівництва за завданнями {#guidance-by-task} -Не впевнені, який контекст використовувати? Запустіть інтерактивний режим: +Налаштування включає керівництва для типових сценаріїв Rete.js. Асистент підключає їх, коли запит відповідає завданню: -```bash -npx rete-kit ai --interactive -``` +| Керівництво | Коли використовувати | Що охоплює | +|-------------|----------------------|------------| +| **rete-onboard** | Вивчення основ Rete.js | Концепції, вузли, з'єднання, сокети, dataflow vs control flow | +| **rete-boot** | Створення нового додатку Rete.js | Вибір стеку, `rete-kit app`, структура проєкту | +| **rete-dev** | Існуючий додаток або інтеграція | Додавання Rete.js до кодової бази, кастомізація, відлагодження | +| **rete-plugin** | Розробка бібліотеки плагінів | Архітектура Scope, `rete-cli`, тестування, PR workflow | -## Як це працює {#how-it-works} +Додаткові керівництва для контриб'юторів організації: **rete-setup** (readonly org mirror), **rete-clone** (редаговані копії бібліотек), **rete-git** (гілки та PR), **rete-qa** (локальна та CI валідація). -Rete Kit читає шаблони інструкцій, специфічні для контексту, зі свого пакету та перетворює їх для вашого IDE: +Спеціалізовані **агенти** для ширших завдань: **rete-code-investigator** (пошук між репозиторіями) та **rete-package-reviewer** (огляд пакетів і PR). -1. **Читає шаблони** з `assets/ai/{context}/` (onboard, boot, dev або plugin) -2. **Перетворює вміст** для формату вашого IDE (наприклад, файли `.mdc` для Cursor) -3. **Записує інструкції** у директорії, специфічні для IDE, у вашому проекті -4. **Активується автоматично** - ШІ-асистент вашого IDE використовує ці інструкції одразу +**Типова послідовність:** вивчення → новий додаток → інтеграція → робота з плагінами — у міру розвитку проєкту описуйте нову мету в чаті. Не потрібно знову запускати `rete-kit ai` для кожної фази. -Згенеровані інструкції містять керівництва, специфічні для Rete.js, адаптовані до вашого вибраного контексту. +## Підтримувані інструменти {#supported-tools} -## Перемикання контекстів {#switching-contexts} +| Інструмент | Статус | Примітки | +|------------|--------|----------| +| Cursor | ✅ Підтримується | `AGENTS.md` проєкту, `.cursor/skills/`, `.cursor/agents/` | +| GitHub Copilot (VS Code) | ✅ Підтримується | `.github/copilot-instructions.md` | +| Claude | ⚠️ Включено | `CLAUDE.md` та шляхи IDE | +| Codex | ⚠️ Включено | `AGENTS.md` | +| Antigravity | ⚠️ Включено | Правила агента та інструкції проєкту | +| Devin Desktop | ⚠️ Включено | Шляхи IDE згідно з tool prompt | +| Kiro | ⚠️ Включено | Шляхи IDE згідно з tool prompt | +| OpenCode | ⚠️ Включено | Шляхи IDE згідно з tool prompt | +| Pi | ⚠️ Включено | Шляхи IDE згідно з tool prompt | -Перемикайте контексти в міру розвитку вашого проекту, запускаючи команду знову з іншим контекстом. Використовуйте `--force` для перезапису існуючих інструкцій: +**Легенда статусу:** +- ✅ **Підтримується** — протестовано та перевірено на правильну роботу +- ⚠️ **Включено** — підтримується, але не повністю протестовано -```bash -npx rete-kit ai --tool cursor --context dev --force -``` +## Вирішення проблем {#troubleshooting} -**Типова послідовність:** `onboard` → `boot` → `dev` → `plugin` +**ШІ-допомога не працює?** +- Перевірте, чи встановлено інструкції проєкту (наприклад, `AGENTS.md` для Cursor, інструкції Copilot для VS Code) +- Розпочніть новий чат або сесію агента — інструкції можуть потребувати нової розмови +- Перезапустіть IDE, якщо нова сесія не допомогла +- Задайте питання про Rete.js, щоб перевірити налаштування (наприклад, «Як додати користувацький вузол?») +- Запустіть `npx rete-kit@latest ai` знову, щоб оновити bundle з останнього релізу rete-kit +- Перевірте налаштування IDE — чи увімкнено функції ШІ -## Вирішення проблем {#troubleshooting} +**Неправильні поради для завдання?** Чіткіше опишіть мету в новому повідомленні — асистент обирає керівництво за запитом, а не за режимом, обраним наперед. -**Інструкції не працюють?** -- Перевірте, чи файли були створені в правильній директорії (наприклад, `.cursor/rules/` для Cursor) -- Спробуйте розпочати нову сесію чату/агента - інструкції можуть потребувати нової розмови для завантаження -- Якщо нова сесія не працює, перезапустіть ваш IDE, щоб переконатися, що інструкції завантажені -- Протестуйте, запитавши ШІ-асистента вашого IDE питання, специфічне для Rete.js -- Перегенеруйте з прапорцем `--force` за потреби -- Перевірте налаштування IDE, щоб переконатися, що функції ШІ увімкнено - -**Вибрано неправильний контекст?** Перегенеруйте з правильним контекстом: -```bash -npx rete-kit ai --tool cursor --context <правильний-контекст> --force -``` +**Папка `.rete/`** — локальні інструменти, зазвичай додається до `.gitignore`. `.rete/scripts/` лишається для org-роботи; `.rete/ai/` — staging для встановлення. Оновлення перезаписує зміни — постійні правки тримайте в інструкціях IDE або файлах проєкту. -**Інтерактивний режим не працює?** Використовуйте явні прапорці `--tool` та `--context` замість цього (інтерактивний режим вимагає TTY). +**Оновлюєтесь зі старішого rete-kit?** `--context`, `--force` та `--interactive` більше не підтримуються — налаштування тепер через агента. Див. [changelog rete-kit](https://github.com/retejs/rete-kit/blob/main/CHANGELOG.md). ## Пов'язана документація {#related-documentation}