# Onboarding

Onboard a user to Wren Engine end-to-end.

- Repository: https://github.com/Canner/WrenAI (18031 stars)
- Category: Data and ML
- License: Apache-2.0
- Last updated: 2026-10-30
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add Canner/WrenAI --skill onboarding -g -a claude-code -y`
Codex: `npx skills add Canner/WrenAI --skill onboarding -g -a codex -y`
Cursor: `npx skills add Canner/WrenAI --skill onboarding -g -a cursor -y`
Gemini CLI: `npx skills add Canner/WrenAI --skill onboarding -g -a gemini-cli -y`

## Description

Onboard a user to Wren Engine end-to-end. Walks through environment checks, project scaffolding, connection configuration via .env, and first query. Use when: user wants to install Wren Engine, set up a new data source connection, or bootstrap a new project from scratch. Triggers: '/wren-onboarding', 'install wren', 'set up wren engine', 'wren onboarding', 'connect new database to wren'.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Wren Onboarding, Agent Workflow

This skill walks the agent through onboarding, environment checks, project scaffolding, profile creation, MDL generation, and first query. **Procedural details, per-datasource setup notes, and the troubleshooting playbook live in the docs**, not here. The skill's job is to enforce the agent-side rules (one step per turn, never ask for credentials in chat) and to dispatch the agent to the right doc / sibling skill at each step.

Reference docs (the skill points to these, never duplicate their content):
- [`docs/core/get_started/installation.md`](https://github.com/Canner/WrenAI/blob/main/docs/core/get_started/installation.md), CLI install + skill install
- [`docs/core/guides/connect.md`](https://github.com/Canner/WrenAI/blob/main/docs/core/guides/connect.md), full connection procedure, **per-datasource setup notes, complete troubleshooting playbook**
- [`docs/core/get_started/quickstart.md`](https://github.com/Canner/WrenAI/blob/main/docs/core/get_started/quickstart.md), bundled `jaffle_shop` demo

## Mode of operation, READ THIS FIRST

**One step per round-trip.** Each numbered step below is its own turn: explain briefly, ask **only** what the step needs, run the command(s), confirm, move on.

The rest: https://github.com/Canner/WrenAI/blob/HEAD/core/wren/src/wren/skills_content/onboarding/SKILL.md