mirror of
https://github.com/Canner/WrenAI.git
synced 2026-09-17 17:43:34 +08:00
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.8
parent
f4f8a13862
commit
5fd887066b
@@ -6,18 +6,18 @@ sidebar_label: Installation
|
||||
|
||||
Get Wren AI running. Your AI coding agent does the rest.
|
||||
|
||||
## 1. Install the skill bundle
|
||||
## 1. Install the skill
|
||||
|
||||
Skills are workflow guides that teach AI coding agents (Claude Code, Openclaw, Hermes, Codex, etc.) how to drive the Wren CLI for you:
|
||||
This installs a single **discovery stub** (`wren`) that teaches AI coding agents (Claude Code, Openclaw, Hermes, Codex, etc.) how to drive the Wren CLI for you:
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*'
|
||||
npx skills add Canner/WrenAI
|
||||
```
|
||||
|
||||
Have multiple AI coding agents installed and want the skills available in all of them? Pass `--agent '*'`:
|
||||
Have multiple AI coding agents installed and want the stub available in all of them? Pass `--agent '*'`:
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent '*'
|
||||
npx skills add Canner/WrenAI --agent '*'
|
||||
```
|
||||
|
||||
Or via the install script:
|
||||
@@ -26,13 +26,13 @@ Or via the install script:
|
||||
curl -fsSL https://raw.githubusercontent.com/Canner/WrenAI/main/skills/install.sh | bash
|
||||
```
|
||||
|
||||
> See the [Skills reference](/oss/reference/skills) for the full list of skills installed and what each one does.
|
||||
> **Only one skill is installed** — `wren` (at `~/.claude/skills/wren/SKILL.md` for Claude Code). This is expected. Since Wren `0.8`, the workflow guides (`onboarding`, `usage`, `generate-mdl`, `dlt-connector`, `enrich-context`) no longer install as separate skills; they live inside the `wren` CLI and the stub fetches them on demand with `wren skills get <name>`. See the [Skills reference](/oss/reference/skills) for the full delivery model and what each guide does.
|
||||
|
||||
## 2. Ask your agent to set things up
|
||||
|
||||
**Start a new agent session** (skills load at session start), open your project directory, and ask:
|
||||
|
||||
Use the `/wren-onboarding` skill to install and set up Wren AI.
|
||||
Use the `/wren` skill to install and set up Wren AI.
|
||||
|
||||
The agent will check your environment, install Python dependencies, create a connection profile for your data source, scaffold the project, and run a first query — all in one flow.
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ A lightweight coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent adal
|
||||
npx skills add Canner/WrenAI --agent adal
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in AdaL, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ A desktop UI for the Aider coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent aider-desk
|
||||
npx skills add Canner/WrenAI --agent aider-desk
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Launch the AiderDesk app, then `File → Open Folder...` to open your project an
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Sourcegraph's coding agent. Uses the shared `.agents/skills/` directory.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent amp
|
||||
npx skills add Canner/WrenAI --agent amp
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ amp
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Google's AI development workspace.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent antigravity
|
||||
npx skills add Canner/WrenAI --agent antigravity
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project folder in Antigravity, then start a new agent session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Augment Code coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent augment
|
||||
npx skills add Canner/WrenAI --agent augment
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -28,7 +28,7 @@ auggie
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ IBM watsonx coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent bob
|
||||
npx skills add Canner/WrenAI --agent bob
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project folder in IBM Bob (watsonx Code Assistant), then start a new c
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Anthropic's official terminal coding assistant.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent claude-code
|
||||
npx skills add Canner/WrenAI --agent claude-code
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ claude
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Open-source autonomous coding agent for VS Code.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent cline
|
||||
npx skills add Canner/WrenAI --agent cline
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in VS Code with the Cline extension installed, then cli
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Huawei Cloud CodeArts Doer.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent codearts-agent
|
||||
npx skills add Canner/WrenAI --agent codearts-agent
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project in CodeArts IDE, then open the CodeArts Agent panel.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Tencent CodeBuddy coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent codebuddy
|
||||
npx skills add Canner/WrenAI --agent codebuddy
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project in CodeBuddy IDE (or the VS Code extension), then open the Cod
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Codemaker AI coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent codemaker
|
||||
npx skills add Canner/WrenAI --agent codemaker
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Codemaker, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ OPPO/Heytap coding IDE.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent codestudio
|
||||
npx skills add Canner/WrenAI --agent codestudio
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Code Studio, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ OpenAI Codex CLI.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent codex
|
||||
npx skills add Canner/WrenAI --agent codex
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ codex
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Command Code agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent command-code
|
||||
npx skills add Canner/WrenAI --agent command-code
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ cmd
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Open-source IDE coding assistant.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent continue
|
||||
npx skills add Canner/WrenAI --agent continue
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in VS Code or a JetBrains IDE with the Continue extensi
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Snowflake Cortex coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent cortex
|
||||
npx skills add Canner/WrenAI --agent cortex
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project in Snowflake's Cortex Code interface, then start a new agent s
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Charm's TUI coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent crush
|
||||
npx skills add Canner/WrenAI --agent crush
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ crush
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ The Cursor IDE.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent cursor
|
||||
npx skills add Canner/WrenAI --agent cursor
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Cursor (`File → Open Folder...` or `⌘O` / `Ctrl+
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ LangChain Deep Agents framework.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent deepagents
|
||||
npx skills add Canner/WrenAI --agent deepagents
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ dcode
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Cognition Devin CLI.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent devin
|
||||
npx skills add Canner/WrenAI --agent devin
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ devin
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Dexto coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent dexto
|
||||
npx skills add Canner/WrenAI --agent dexto
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Dexto, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Factory AI Droid CLI.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent droid
|
||||
npx skills add Canner/WrenAI --agent droid
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ droid
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Android JetBrains coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent firebender
|
||||
npx skills add Canner/WrenAI --agent firebender
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project in a JetBrains IDE with the Firebender plugin installed, then
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Forge AI coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent forgecode
|
||||
npx skills add Canner/WrenAI --agent forgecode
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ forge
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Google's official Gemini CLI.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent gemini-cli
|
||||
npx skills add Canner/WrenAI --agent gemini-cli
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ gemini
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ GitHub Copilot CLI / Coding Agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent github-copilot
|
||||
npx skills add Canner/WrenAI --agent github-copilot
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project folder in VS Code (or another supported IDE) with GitHub Copil
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Block's open-source coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent goose
|
||||
npx skills add Canner/WrenAI --agent goose
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ goose session
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Hermes coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent hermes-agent
|
||||
npx skills add Canner/WrenAI --agent hermes-agent
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Hermes Agent, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ iFlow CLI agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent iflow-cli
|
||||
npx skills add Canner/WrenAI --agent iflow-cli
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ iflow
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ JetBrains Junie.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent junie
|
||||
npx skills add Canner/WrenAI --agent junie
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project in a JetBrains IDE with the Junie plugin installed, then open
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ VS Code coding agent (fork of Roo Code).
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent kilo
|
||||
npx skills add Canner/WrenAI --agent kilo
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -27,7 +27,7 @@ kilo
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Moonshot Kimi CLI. Uses the shared `.agents/skills/` directory.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent kimi-cli
|
||||
npx skills add Canner/WrenAI --agent kimi-cli
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ kimi
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ AWS Kiro CLI.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent kiro-cli
|
||||
npx skills add Canner/WrenAI --agent kiro-cli
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ kiro
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ shareAI Kode coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent kode
|
||||
npx skills add Canner/WrenAI --agent kode
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ kode
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ MCPJam development tool.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent mcpjam
|
||||
npx skills add Canner/WrenAI --agent mcpjam
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in MCPJam, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Mistral's Vibe coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent mistral-vibe
|
||||
npx skills add Canner/WrenAI --agent mistral-vibe
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ vibe
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Mux coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent mux
|
||||
npx skills add Canner/WrenAI --agent mux
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Mux, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Neovate coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent neovate
|
||||
npx skills add Canner/WrenAI --agent neovate
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ neovate
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ OpenClaw coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent openclaw
|
||||
npx skills add Canner/WrenAI --agent openclaw
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ openclaw
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ SST's open-source coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent opencode
|
||||
npx skills add Canner/WrenAI --agent opencode
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ opencode
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ All-Hands open-source coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent openhands
|
||||
npx skills add Canner/WrenAI --agent openhands
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ openhands
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Pi Mono coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent pi
|
||||
npx skills add Canner/WrenAI --agent pi
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -25,7 +25,7 @@ pi
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Pochi coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent pochi
|
||||
npx skills add Canner/WrenAI --agent pochi
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Pochi, then start a new chat session.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Qoder coding IDE.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent qoder
|
||||
npx skills add Canner/WrenAI --agent qoder
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project folder in Qoder IDE, then open the Qoder chat panel.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Alibaba Qwen Code CLI.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent qwen-code
|
||||
npx skills add Canner/WrenAI --agent qwen-code
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ qwen
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Open-source VS Code coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent roo
|
||||
npx skills add Canner/WrenAI --agent roo
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in VS Code with the Roo Code extension installed, then
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Atlassian Rovo Dev.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent rovodev
|
||||
npx skills add Canner/WrenAI --agent rovodev
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ acli rovodev run
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Tabnine CLI coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent tabnine-cli
|
||||
npx skills add Canner/WrenAI --agent tabnine-cli
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -26,7 +26,7 @@ tabnine
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Trae (China region).
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent trae-cn
|
||||
npx skills add Canner/WrenAI --agent trae-cn
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project folder in Trae CN IDE (`File → Open Folder...`), then open t
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ ByteDance Trae IDE.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent trae
|
||||
npx skills add Canner/WrenAI --agent trae
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Trae IDE (`File → Open Folder...`), then open the
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Warp terminal coding agent. Uses the shared `.agents/skills/` directory.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent warp
|
||||
npx skills add Canner/WrenAI --agent warp
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open Warp, then press `⌘I` / `Ctrl+I` to enter Agent Mode.
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ Codeium Windsurf IDE.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent windsurf
|
||||
npx skills add Canner/WrenAI --agent windsurf
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -23,7 +23,7 @@ Open your project folder in Windsurf (`File → Open Folder...`), then open the
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -14,7 +14,7 @@ Zencoder coding agent.
|
||||
## Install Wren skills
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*' --agent zencoder
|
||||
npx skills add Canner/WrenAI --agent zencoder
|
||||
```
|
||||
|
||||
## Run onboarding
|
||||
@@ -24,7 +24,7 @@ Open your project folder in VS Code or a JetBrains IDE with the Zencoder extensi
|
||||
Then ask:
|
||||
|
||||
```text
|
||||
Use the /wren-onboarding skill to install and set up Wren AI.
|
||||
Use the /wren skill to install and set up Wren AI.
|
||||
```
|
||||
|
||||
The skill walks the agent through environment checks, profile creation, project scaffolding, and a first query.
|
||||
|
||||
@@ -13,7 +13,7 @@ This guide drops three things on you in the first few steps. Skim before you sta
|
||||
- **Wren CLI (`wren`)** — the Python CLI that runs all of this. Connects to a database, holds your modeling files, executes SQL through the semantic layer, manages a local memory index. ([CLI reference →](/oss/reference/cli))
|
||||
- **MDL (Modeling Definition Language)** — YAML files under `models/`, `views/`, and `relationships.yml` that describe your tables, columns, and joins in business terms. The agent reads MDL instead of guessing from raw schema. ([MDL concept →](/oss/concepts/what_is_mdl) · [Wren project guide →](/oss/reference/mdl))
|
||||
- **jaffle_shop** — a public sample database from dbt Labs. We use it so you do not need to bring your own database to follow this quickstart. It is a fictional ecommerce business with `customers`, `orders`, `products`, and `supplies`. *(Want to skip jaffle_shop and use your own database? Finish the install in step 2 then jump to [Connect your database](/oss/guides/connect).)*
|
||||
- **Skills** — markdown workflow guides that tell an AI coding agent (Claude Code, Openclaw, Hermes, Codex, etc.) how to operate the CLI. Two skills drive this quickstart: `wren-generate-mdl` (one-time scaffolding) and `wren-usage` (day-to-day querying). ([Skills concept →](/oss/reference/skills))
|
||||
- **Skills** — markdown workflow guides that tell an AI coding agent (Claude Code, Openclaw, Hermes, Codex, etc.) how to operate the CLI. You install one `wren` discovery stub; it fetches the guides from the CLI on demand. Two guides drive this quickstart: `generate-mdl` (one-time scaffolding) and `usage` (day-to-day querying). ([Skills concept →](/oss/reference/skills))
|
||||
|
||||
---
|
||||
|
||||
@@ -88,26 +88,26 @@ wren version
|
||||
|
||||
---
|
||||
|
||||
## Step 3 — Install CLI skills
|
||||
## Step 3 — Install the CLI skill
|
||||
|
||||
Skills are workflow guides that tell your AI coding agent how to use the Wren CLI effectively. Install the skill bundle:
|
||||
Skills are workflow guides that tell your AI coding agent how to use the Wren CLI effectively. Install the discovery stub — it fetches the guides from the CLI on demand:
|
||||
|
||||
```bash
|
||||
npx skills add Canner/WrenAI --skill '*'
|
||||
npx skills add Canner/WrenAI
|
||||
# or:
|
||||
curl -fsSL https://raw.githubusercontent.com/Canner/WrenAI/main/skills/install.sh | bash
|
||||
```
|
||||
|
||||
The CLI auto-detects your installed agent. To target a specific one, add `--agent <name>` (e.g., `claude-code`, `cursor`, `windsurf`, `cline`).
|
||||
The CLI auto-detects your installed agent. To target a specific one, add `--agent <name>` (e.g., `claude-code`, `cursor`, `windsurf`, `cline`). Only one skill (`wren`) is installed; the workflow guides below are served on demand with `wren skills get <name>`.
|
||||
|
||||
This quickstart uses two of the installed skills:
|
||||
This quickstart uses two of those guides:
|
||||
|
||||
| Skill | Purpose |
|
||||
| Guide | Purpose |
|
||||
|-------|---------|
|
||||
| **wren-usage** | Day-to-day workflow — gather context, recall past queries, write SQL, store results |
|
||||
| **wren-generate-mdl** | One-time setup — explore database schema and generate the MDL project |
|
||||
| **usage** | Day-to-day workflow — gather context, recall past queries, write SQL, store results |
|
||||
| **generate-mdl** | One-time setup — explore database schema and generate the MDL project |
|
||||
|
||||
For the full skill list (including `wren-onboarding` and `wren-dlt-connector`), see the [Skills reference](/oss/reference/skills).
|
||||
For the full guide list (including `onboarding` and `dlt-connector`), see the [Skills reference](/oss/reference/skills).
|
||||
|
||||
---
|
||||
|
||||
@@ -218,10 +218,12 @@ claude
|
||||
Then ask:
|
||||
|
||||
```
|
||||
Use the wren-generate-mdl skill to explore the jaffle_shop database
|
||||
Use the /wren skill to explore the jaffle_shop database
|
||||
and generate the MDL for all tables. The data source is DuckDB.
|
||||
```
|
||||
|
||||
The `wren` skill recognizes this as a scaffolding task and pulls in the `generate-mdl` guide (`wren skills get generate-mdl`) to drive it.
|
||||
|
||||
Claude Code will:
|
||||
|
||||
1. **Discover tables** — `customers`, `orders`, `products`, `supplies`, etc.
|
||||
@@ -258,7 +260,7 @@ What are the top 5 products by total revenue?
|
||||
Show me the monthly order count trend.
|
||||
```
|
||||
|
||||
Behind the scenes, Claude Code uses the **wren-usage** skill to:
|
||||
Behind the scenes, Claude Code uses the **usage** guide to:
|
||||
|
||||
1. **Fetch context** (`wren memory fetch`) — find relevant tables and columns for your question
|
||||
2. **Recall examples** (`wren memory recall`) — find similar past queries
|
||||
|
||||
Reference in New Issue
Block a user