Getting Started
Pro on Nuxt
Install the Nuxt starter from the private registry and open your dashboard locally.
Use this guide to run the Nuxt starter locally. It includes sign-in, a dashboard, example agents
and tools, automation templates, and a customers Agentic Model. Local development uses real
Cloudflare bindings, so the same app can run after deployment.
Requirements
- Node.js 22.22.3+ or 24.15+, and pnpm 10.33+.
- A Nuxt Agentic Pro license key, from your purchase email.
- Access to the private
nuxt-agentic-starterrepository on GitHub, granted with your purchase.
1. Connect the Private Registry
Pro packages install from registry.nuxtagentic.com; your license key grants access to the
releases in your update window. Other dependencies, including @nuxtagentic/nuxt, install from
the public npm registry.
Run the public setup CLI once per machine, then paste your license key at the masked prompt:
pnpm dlx @nuxtagentic/cli@latest login
With npm, use npx @nuxtagentic/cli@latest login. Use @next for release candidates.
The public CLI installs from npm, validates the key, and saves the scope and credentials in
your user ~/.npmrc. The starter's .npmrc.example contains only the scope line.
After installing the starter, use pnpm exec agentic login to replace a renewed key. Check
access with pnpm exec agentic status; remove the saved token with pnpm exec agentic logout.
See Licensing for update windows and CI access.
2. Create Your Project
Use the starter repository as a template, or clone it:
git clone <your-starter-repository-url> my-app
cd my-app
pnpm install
If pnpm install fails on a @nuxtagentic-pro package with 404, the scope does not point at
the registry yet. A 401 means the registry did not accept the key: check it against your
purchase email.
3. Configure and Migrate
Create the secrets and the local database:
pnpm exec agentic keygen # creates .env with BETTER_AUTH_SECRET and AGENTIC_ENCRYPTION_KEY
pnpm db:migrate # applies server/database/migrations to the local D1 database
Add a provider key (OPENAI_API_KEY, ANTHROPIC_API_KEY, or GOOGLE_AI_API_KEY) to .env. To
try runs without a key, switch an agent to the built-in mock provider.
4. Run It
Start the app, then seed it from a second terminal:
pnpm dev # http://localhost:3000/dashboard
pnpm db:seed # in a second terminal: demo account and example customers
Sign in with demo@example.com and demo-password-123. When something is off,
pnpm exec agentic doctor checks Node, pnpm, .env, bindings, migrations, package versions, and
your license.
Where Things Live
| Path | What |
|---|---|
server/models/*.ts | Agentic Models: a Drizzle table plus defineAgenticModel |
server/agents/*.md | Code agents: frontmatter and instructions, read-only in the UI |
server/tools/*.ts | Agent tools with defineAgentTool |
server/automations/*.ts | Automation templates with defineAutomation |
server/integrations/*.ts | Your own integrations with defineIntegration |
server/agentic.ts | Optional: auth options, extra features, updateRecord |
server/database/schema.ts | Schema for migrations: package tables plus your models |
app/ | Your pages; override any dashboard page, component, or app.config.ts |
Files in these folders are discovered automatically. On the server, defineAgentTool,
defineAgenticModel, defineAutomation, defineIntegration, and useAgentic(event) are
auto-imported. In app/, useDurableAgent, useAgentRun, useAutomation, useAgenticClient,
and useWorkspace are.
Next Steps
- Agents and tools.
- Agentic Models: your tables as agent tools.
- Deploy to Cloudflare.