Get Started with Jay
Jay is an AI-native full-stack framework. You work alongside AI agents — they generate pages, you guide the design. One command to scaffold a project.
Three Steps to Launch
One command scaffolds your project, installs dependencies, and generates the AI agent discovery kit.
Create
Run npm create jay@latest to scaffold a new project. Choose a project name and select the plugins you need.
Configure
Pick capabilities from AI guardrails to Wix headless integration. Jay installs everything and generates the agent-kit automatically.
Develop
Start the dev server with npm run dev. AI agents read the agent-kit to understand your project and begin building pages.
Non-Interactive Mode
AI agents can create projects without prompts. Pass all options as flags to skip the interactive CLI.
Use exact plugin names, comma-separated, in quotes. All plugins from the interactive selector are available.
What Gets Created
Everything in One Place
Jay uses a file-based structure where each page is a directory under src/pages/. Three files define a page:
- page.jay-html — the template with data bindings, conditions, and loops
- page.ts — the component that provides data across rendering phases
- page.jay-contract — the data shape that connects template and component
The agent-kit/ folder is auto-generated. AI agents read it to discover plugins, contracts, and project structure.
Key Commands
| Command | Description |
|---|---|
| npm run dev | Start dev server with hot reload |
| npm run build | Production build (SSR + static) |
| npm run serve | Serve the production build locally |
| npm run validate | Check templates, contracts, SEO, a11y |
| npm run agent-kit | Regenerate AI agent discovery index |
| npm run setup | Run plugin configuration |
Wix Plugin Configuration
Additional setup for connecting to Wix backend services.
Setup Steps
If you selected any Wix plugins (Stores, Members, Media, Data, Deploy), follow these steps to connect to Wix backend services.
Initialize Wix Credentials
Run npm create @wix/new@latest init to log in to Wix (or register for Wix Headless), connect your site, and generate the wix.config.json required for deployment — containing your site ID and client ID.
Run Plugin Setup
Run npm run setup to create config/.wix.yaml with connection details.
Generate an API Key
Go to Wix Dashboard, Account Settings, API Keys. Create a new key and paste it into config/.wix.yaml.
Plugin-Specific Setup
Wix Stores: Install the Stores app from the Wix App Market.
Wix Deploy: Create a jay-backend-files collection in Wix CMS.
Wix Members: Enable member signup in your Wix Dashboard.
Wix Media & Data: No additional setup required.
Verify
Run npm run setup again to validate all credentials are configured correctly.