Reference

CLI

The agentic command for login, health checks, upgrades, ejecting pages, secrets and coding agents.

Before installing a starter, authenticate with the public CLI:

pnpm dlx @nuxtagentic/cli@latest login

The npm equivalent is npx @nuxtagentic/cli@latest login. Use @next for release candidates. The public CLI also provides status (whoami) and logout without a project installation.

The starters install @nuxtagentic-pro/cli as a dev dependency. Run project commands with pnpm exec agentic <command>. Every command takes --project <dir> (default: the current directory).

Command	What it does
`agentic login`	Checks your license key and stores registry access in your user `~/.npmrc`
`agentic status`	Checks effective registry access, license tier and update window
`agentic logout`	Removes the registry token from your user npm config
`agentic doctor`	Checks Node.js, pnpm, `.env`, bindings, migrations, versions and license
`agentic upgrade [version]`	Moves every Nuxt Agentic package to one release and reinstalls
`agentic eject [path]`	Nuxt: copies a dashboard file from the layer into `app/`
`agentic keygen`	Writes `AGENTIC_ENCRYPTION_KEY` and `BETTER_AUTH_SECRET` to `.env`
`agentic plugin <client>`	Writes the Claude Code or Codex plugin for this project
`agentic mcp`	The stdio MCP server the plugin starts

Use login to switch or renew a key. It validates the key before saving it and never echoes the interactive prompt. For automation, provide the key through stdin or AGENTIC_LICENSE_KEY. Credentials go only in your user npm config (NPM_CONFIG_USERCONFIG or ~/.npmrc, mode 600); the command refuses to write a project .npmrc.

status and logout

status (also whoami) validates effective project and user registry settings, then prints your tiers, update window, and config path. It exits with an error if access is missing, refused, or overridden. The key is never printed.

logout removes the token from the user npm config while preserving registry routing and unrelated settings. Project credentials and environment variables keep their own configuration.

doctor

Prints one line per check and exits with an error when any check fails:

Node.js against engines.node, and pnpm against packageManager.
.env: AGENTIC_ENCRYPTION_KEY (32 bytes, base64), BETTER_AUTH_SECRET, provider keys.
Nuxt: the DB (D1) and STORAGE (R2) bindings in wrangler.jsonc, including a placeholder database_id.
Pending local migrations.
Installed Nuxt Agentic packages match package.json and each other.
The registry route, your license tier and update window.

upgrade

By default, upgrade uses the registry's latest tag (next for prereleases). Select a version with agentic upgrade 1.2.0 or a tag with --tag next. It pins Nuxt Agentic dependencies, applies intervening codemods, installs packages (skip with --skip-install), and prints a starter comparison. Then run pnpm db:generate and pnpm db:migrate. See Upgrading.

eject

Lists the layer's dashboard files, or copies one into your app/ directory: agentic eject pages/dashboard/agents.vue. Existing files are never overwritten. See Dashboard UI.

keygen

Creates .env from .env.example when it is missing and fills AGENTIC_ENCRYPTION_KEY and BETTER_AUTH_SECRET when they are missing or empty. It never replaces a value: a new encryption key makes stored integration credentials unreadable. Production uses its own secrets.

plugin and mcp

agentic plugin claude or agentic plugin codex connects a coding agent to your running dev server. agentic mcp is the server the plugin starts; it takes --user EMAIL and --workspace ID (or AGENTIC_MCP_USER and AGENTIC_MCP_WORKSPACE). See Coding agents.

REST API

Every route the Agentic API serves, generated from the route manifest.

Licensing & FAQ

What each license covers, how updates work, and answers to common questions.