@paljs/cli

Introduction

A powerful command-line interface for generating full-stack applications with Prisma, GraphQL, and modern frontend frameworks. The PalJS CLI automates the creation of CRUD operations, admin interfaces, and GraphQL schemas.

Installation

Global Installation

Project Installation

Quick Start

After installation, create a new project:

Commands Overview

The PalJS CLI provides three main commands:

Usage

pal create

Create a new full-stack application with Prisma and GraphQL through an interactive setup process.

Interactive Setup Process:

The create command runs an interactive setup that will prompt you for:

1. Project Name - The name of your new project
2. Project Description - Brief description of your project
3. Author - Project author name
4. Repository - Git repository URL
5. Use Git - Whether to initialize a git repository
6. Package Manager - Choose between npm or yarn
7. Skip Installation - Whether to skip package installation
8. Example Template - Choose from available project templates:
   • full-stack-nextjs - Complete Next.js application with Prisma
   • apollo-nexus-schema - Apollo Server with Nexus schema-first approach
   • apollo-sdl-first - Apollo Server with SDL-first approach
   • graphql-modules - GraphQL Modules architecture

Additional Options for Full-Stack Next.js:

If you select the full-stack-nextjs template, you'll be prompted for:

• UI Framework - Choose from:
  • Material UI
  • Material UI + PrismaAdmin UI
  • Tailwind CSS
  • Tailwind CSS + PrismaAdmin UI
  • Chakra UI
  • Chakra UI + PrismaAdmin UI
• Multi-Schema Support - Whether to use multi-schema template

Example Session:

$ pal create
 
.______      ___       __             __       _______.
|   _  \    /   \     |  |           |  |     /       |
|  |_)  |  /  ^  \    |  |           |  |    |   (----`
|   ___/  /  /_\  \   |  |     .--.  |  |     \   \
|  |     /  _____  \  |  `----.|  `--'  | .----)   |
| _|    /__/     \__\ |_______| \______/  |_______/
 
? please enter your project name › my-awesome-app
? please enter your project description › My awesome GraphQL app
? please enter your project author › John Doe
? please enter your project repository › https://github.com/johndoe/my-app
? Do you need to use Git › yes
? please select your package manager › yarn
? Skip package installation › no
? Please select your start example › full-stack-nextjs
? Please select your start framework › Tailwind CSS + PrismaAdmin UI
? Use multi schema template › no

pal generate [models] [type]

Generate CRUD operations, admin pages, and GraphQL queries/mutations.

Arguments:

• models - Comma-separated list of model names (optional)
• type - Type of files to generate: crud, queries, mutations, admin, graphql

Available Flags:

• -c, --config <file> - Custom config file name (default: pal.config)
• -s, --schema <name> - Schema name from config file
• -m, --multi - Work with multi-schema configuration
• -a, --autoComplete <path> - Generate CLI auto-completion for oh-my-zsh

Examples:

Generate everything for all models:

Generate for specific models:

Generate specific types:

Generate admin pages only:

Use custom config file:

Multi-schema mode:

pal schema <converter>

Convert and manipulate Prisma schema files.

Arguments:

• converter - Conversion type: json, typescript, camel-case

Available Flags:

• -o, --output-path <path> - Output folder path (default: src/)
• -t, --type <type> - Output file type for JSON conversion: js, ts, json (default: ts)
• -s, --schema <path> - Custom schema file path

Examples:

Convert schema to JSON:

Convert to TypeScript types:

Convert snake_case to camelCase:

Convert to TypeScript with custom output:

Convert to JSON as JavaScript file:

Convert specific schema file:

Development Server

To run your generated application:

Complete Project Setup Example

Here's a complete workflow for setting up a new project:

# 1. Create new project (interactive)
npx pal create
 
# Follow the interactive prompts:
# - Enter project name: my-blog
# - Choose framework: Tailwind CSS + PrismaAdmin UI
# - Set other options as needed
 
# 2. Navigate to project
cd my-blog
 
# 3. Update your Prisma schema
# Edit prisma/schema.prisma
 
# 4. Generate database migration
npx prisma migrate dev
 
# 5. Generate GraphQL CRUD operations
npx pal generate
 
# 6. Generate admin interface
npx pal generate admin
 
# 7. Start development server
npm run dev

Command Reference

Global Options

Command Aliases

Features

• Interactive Project Creation: Guided setup process for new projects
• CRUD Generation: Automatic creation of GraphQL operations
• Multiple Templates: Choose from various project templates
• UI Framework Support: Support for popular UI frameworks
• Type Safety: Full TypeScript support throughout
• Package Manager Agnostic: Works with npm, yarn, and pnpm
• Multi-Schema Support: Handle multiple Prisma schemas
• Schema Conversion: Convert schemas to different formats