@zapi-x/cli
v0.1.0-beta.3
Published
CLI for zapi - Zero to API in seconds
Downloads
189
Maintainers
Readme
@zapi-x/cli
Command-line interface for zapi - Zero to API in seconds.
Installation
npm install -g @zapi-x/cli
# or use with npx
npx @zapi-x/cli generateUsage
Generate Command
Generate Prisma schema, TypeScript types, and API client from your entity definitions:
zapi generateOptions:
-c, --config <path>- Path to zapi config file (default:./zapi.config.ts)-o, --out <dir>- Output directory (default:./generated)-p, --provider <provider>- Database provider: sqlite, postgresql, mysql (default:sqlite)
Init Command
Get help on initializing a new zapi project:
zapi initFor full project scaffolding, use:
npm create zapi-x@latestConfiguration
Create a zapi.config.ts file in your project root:
import { entity, string, text, belongsTo } from "@zapi-x/core"
export const user = entity("user", {
email: string.unique(),
name: string,
})
export const post = entity("post", {
title: string,
body: text,
author: belongsTo(() => user),
}).ownedBy("author")
export default {
entities: [user, post],
}Then run:
npx @zapi-ts/cli generate
npx prisma db push --schema=./generated/prisma/schema.prismaOutput
The generator creates:
generated/prisma/schema.prisma- Prisma database schemagenerated/types.ts- TypeScript interfaces for all entitiesgenerated/client.ts- Typed API client for frontend use
Learn More
License
MIT
