Index of every page on this site: llms.txt
All skills
onmax avatar

/nuxt-users

@b4e1a3f official
by Maxonmax/nuxt-skills729 stars
38
Run it yourself

Configure and use the nuxt-users module for Nuxt. Use when adding authentication, user management, roles, password reset, database setup (SQLite/MySQL/PostgreSQL), or CLI commands (migrate, create-user). Covers nuxt.config (nuxtUsers), composables (useAuthentication, useUsers, usePublicPaths, usePasswordValidation, useNuxtUsersLocale), components (NUsersLoginForm, NUsersLogoutLink, etc.), and authorization (whitelist, permissions).

Use this Skill: https://skilld.dev/gh/onmax/nuxt-skills/nuxt-users

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈112 tokens for metadata: the name and description. ≈1.6k when used: this file.

Description uses 5.6% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈448 characters, or 5.6%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Nuxt Users skill

Initial setup

  1. Install the module and peer dependencies

    npm install nuxt-users
    npm install db0 better-sqlite3 bcrypt nodemailer

    For MySQL or PostgreSQL, install the corresponding driver (mysql2 or pg) instead of or in addition to better-sqlite3 as required.

  2. Register the module in nuxt.config.ts

    export default defineNuxtConfig({
      modules: ['nuxt-users']
    })
  3. Run migrations From the project root (where nuxt.config.ts lives):

    npx nuxt-users migrate
  4. Create at least one user

    npx nuxt-users create-user -e admin@example.com -n "Admin User" -p password123 -r admin

    Flags: -e email, -n name, -p password, -r role (optional).

  5. Configure permissions

    export default defineNuxtConfig({
      modules: ['nuxt-users'],
      nuxtUsers: {
        auth: {
          permissions: {
            admin: ['*'],
            user: ['/profile', '/api/nuxt-users/me']
          }
        }
      }
    })
  6. Use login in a page

    • Use the NUsersLoginForm component and handle @success by calling login(user) from useAuthentication().
    • Optionally redirect after login (e.g. navigateTo('/')).

Configuration reference (nuxt.config.ts)

All options live under nuxtUsers in nuxt.config.ts.

Area Key Notes
Database connector.name 'sqlite' | 'mysql' | 'postgresql'
Database connector.options path (SQLite), or host, port, user, password, database (MySQL/PostgreSQL)
API apiBasePath Default '/api/nuxt-users'
Tables tables.users, tables.personalAccessTokens, tables.passwordResetTokens, tables.migrations Custom table names
Mailer mailer Nodemailer config for password reset emails
URLs siteUrl Public app URL for links in emails (e.g. 'https://example.com'). Required in production; the Host header is only trusted in development
URLs passwordResetUrl, emailConfirmationUrl Paths for redirects
Auth auth.whitelist Public routes (e.g. ['/register']); /login is always public
Auth auth.tokenExpiration Minutes (default 1440)
Auth auth.rememberMeExpiration Days (default 30)
Auth auth.permissions Role → paths (e.g. admin: ['*'], user: ['/profile']). Keys are the predefined roles.
Auth auth.allowCustomRoles Default false. When true, create/update APIs and NUsersUserForm accept roles not listed in permissions. Empty permissions (bootstrap) already accepts any role.
Auth auth.google Google OAuth: clientId, clientSecret, callbackUrl, etc.
Password passwordValidation minLength, requireUppercase, requireLowercase, requireNumbers, requireSpecialChars, preventCommonPasswords
Data hardDelete true = hard delete, false = soft delete (default)
Locale locale.default, locale.texts, locale.fallbackLocale Localization

Runtime config is also supported: use runtimeConfig.nuxtUsers for env-based or server-only settings.

CLI commands

Run from the project root so nuxt.config.ts (and optionally .env) are found.

  • Migrations

    npx nuxt-users migrate
  • Create user

    npx nuxt-users create-user -e <email> -n "<name>" -p <password> [-r <role>]

    Role should match a auth.permissions key unless auth.allowCustomRoles is true (or permissions are empty).

  • Legacy/table creation

    npx nuxt-users create-users-table
    npx nuxt-users create-personal-access-tokens-table
    npx nuxt-users create-password-reset-tokens-table
    npx nuxt-users create-migrations-table

Production: The CLI requires nuxt-users (and peers) installed where Node runs — it is not bundled inside .output/. Full config needs the app root with nuxt.config; build-only or --omit=dev deploys fall back to DB_* env vars. See docs/user-guide/configuration.md.

Composables (auto-imported)

  • useAuthentication() — user, isAuthenticated, login(user, rememberMe?), logout(), fetchUser(useSSR?), initializeUser()
  • useUsers() — Admin: users, pagination, loading, error, fetchUsers(page?, limit?), updateUser, addUser, removeUser(userId)
  • usePublicPaths() — getPublicPaths(), getAccessiblePaths(), isPublicPath(path), isAccessiblePath(path, method?)
  • usePasswordValidation(moduleOptions?, options?) — validate(password), isValid, errors, strength, score, clearValidation()
  • useNuxtUsersLocale() — t(key, params?), currentLocale, fallbackLocale

Components

  • NUsersLoginForm — Login form; use @success to call login(user) from useAuthentication()
  • NUsersLogoutLink — Logout link/button
  • NUsersProfileInfo — Display profile
  • NUsersResetPasswordForm — Password reset form
  • NUsersList — List users (admin)
  • NUsersUserForm — Create/edit user form; role select from auth.permissions keys; set auth.allowCustomRoles: true for a custom free-text role option

Troubleshooting

Symptom Fix
Redirected to login on protected routes Set auth.permissions so each role has access to needed routes
CLI config not found / wrong tables Run CLI from the directory containing nuxt.config; see production note above
Migrations table missing Run npx nuxt-users migrate from project root
Database driver errors Install correct peer: SQLite → better-sqlite3, MySQL → mysql2, PostgreSQL → pg

File references

  • Project LLM context and config types: llms.txt in the repo root
  • Full docs: https://nuxt-users.webmania.cc/
  • Getting started and examples: ../../docs/user-guide/getting-started.md, ../../docs/examples/basic-setup.md
  • Authorization: ../../docs/user-guide/authorization.md
  • Configuration details: ../../docs/user-guide/configuration.md

Keep nuxtUsers config and permissions in sync with the app’s roles and routes; use guard clauses and early returns when implementing custom auth logic.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts10d3 checks · Risk SAFE
  • Gen Agent Trust Hub11d

    The skill provides instructions for setting up and using the nuxt-users module for Nuxt applications. It includes standard package installations, configuration examples, and CLI commands for database management and user creation. No malicious patterns or security risks were identified.

  • Socket10d

    No alerts

  • Snyk11d

    Risk: LOW · No issues

Signed by skilld at b4e1a3f. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 14 hours ago.

Activeupdated 2 weeks ago
metadata
{
  "author": "rrd108",
  "version": "1.0"
}

README badge

README badge for onmax/nuxt-skills/nuxt-users