Nuxt CRUD CLI

A command-line tool for generating API resources for Nuxt 3 CRUD applications.

Warning

This package is not tested and highly experimental.

Installation

npm install -g nuxt-crud-cli

Or use it directly with npx:

npx nuxt-crud-cli generate

Usage

The CLI tool provides an interactive interface to generate API resources for your Nuxt 3 application.

# Generate a resource
nuxt-crud generate

# Show help
nuxt-crud --help

What it Generates

This tool can generate the following components for your API:

1. Controllers: Handle business logic for your resources
2. Requests: Validate incoming request data using Zod schemas
3. Resources: Transform data for API responses

Examples

Generate a complete product resource:

nuxt-crud generate

Then follow the interactive prompts to:

1. Enter a resource name (e.g., "product")
2. Choose what to generate (e.g., "All")
3. Select which requests to generate
4. Enter the API version (default: "v1")
5. Choose whether to create route files

Resource Structure

The generated resources follow this structure:

server/
  api/
    v1/
      products/
        ProductController.ts
        [id].ts
        index.ts
        handlers/
          create.ts
          delete.ts
          getAll.ts
          getOne.ts
          update.ts
        requests/
          DeleteProductRequest.ts
          GetAllProductsRequest.ts
          GetOneProductRequest.ts
          StoreProductRequest.ts
          UpdateProductRequest.ts
        resources/
          productCollection.ts
          productResource.ts
          types.ts

License

MIT