onboarding

Guides agents through Wren Engine installation, project scaffolding, connection setup, and first query.

17.7k|2.0k|Updated Mar 13, 2024
One-click install
npx skills add https://github.com/Canner/WrenAI --skill onboarding-canner
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: onboarding
Source: https://github.com/Canner/WrenAI/tree/main/core/wren/src/wren/skills_content/onboarding
Command: npx skills add https://github.com/Canner/WrenAI --skill onboarding-canner

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Setting up Wren Engine from scratch involves many ordered steps—environment checks, CLI installation, credential configuration, profile creation, and MDL generation—and doing them out of order causes confusing failures. This Skill walks an AI agent through the entire onboarding flow one step at a time, enforcing safe rules like never asking for credentials in chat. ## Core Features & Use Cases - Guided Environment Preflight: Checks Python version, virtualenv status, and existing CLI installation before any project work begins. - Credential-Safe Connection Setup: Generates a .env template introspected from the live connector schema via wren docs connection-info, so secrets never pass through the chat. - Project Scaffolding and Binding: Creates the project layout with wren context init, binds a validated connection profile, and hands off to MDL generation before any query runs. - Use Case: A user says "set up Wren Engine and connect my Postgres database." The agent checks the environment, scaffolds the project, generates the .env template, validates the connection profile, builds the MDL, and finishes with suggested natural-language questions. ## Quick Start Ask your agent to run the Wren onboarding flow by saying "set up Wren Engine and connect my database" or invoking /wren-onboarding.

Frequently Asked Questions about onboarding

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up Wren Engine and connect a database?▼

Install the CLI with pip install wrenai, then follow the onboarding flow: run environment checks, create a project directory, generate a .env template with wren docs connection-info, and validate the connection with wren profile add. The skill enforces one step per turn.

How do I configure database credentials for Wren without exposing them?▼

Credentials always go through a .env file that you fill in your own editor; the agent never sees the values. The skill generates the template with empty UPPER_SNAKE keys introspected from the connector schema, and suggests chmod 600 and gitignore protection.

Which databases does Wren Engine support for connections?▼

Wren supports postgres, mysql, bigquery, snowflake, clickhouse, trino, duckdb, and more. Run wren docs connection-info with no argument to see the full list of supported datasources and their required fields.

Why does my Wren query fail right after connecting a database?▼

Queries fail because the MDL (model definition layer) has not been built yet. You must run the generate-mdl skill to introspect tables and generate YAML models, then run wren context validate and wren context build before querying.

What Python version is required to install the wrenai CLI?▼

Wren requires Python 3.11 or newer. The onboarding preflight checks python3 --version first and stops with an upgrade request if the version is older, and it also recommends using a virtualenv on PEP 668 systems.