Usage

Scaffolding a New Project #

@lakeql/create-app is LakeQL's project scaffolding tool. It downloads a starter template, configures dependencies, and sets up your project structure.

Quick Start #

npm create @lakeql/app my-api

Interactive Mode #

When run without arguments, the CLI prompts you for:

1. Project name — lowercase letters, numbers, hyphens, and underscores
2. Install dependencies — yes/no
3. Package manager — npm, pnpm, or yarn

npm create @lakeql/create-app@latest

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
◆  create-lakeql-app
│
◇  What is your project name?
│  my-lakeql-api
│
◇  Install dependencies?
│  Yes
│
◇  Which package manager?
│  pnpm
│
◇  Template downloaded successfully!
◇  Package.json updated!
◇  Dependencies installed!
│
└  🎉 Project created successfully!

CLI Flags #

Examples #

1
2
3
4
5
6
7
8
9
# Non-interactive with pnpm
npx @lakeql/create-app@latest my-api --package-manager=pnpm

# Skip install for CI
npx @lakeql/create-app@latest my-api --no-install --quiet

# Short form
npx @lakeql/create-app@latest my-api -pm=yarn

What Happens #

Project Name Validation #

Project names must match the pattern: ^[a-z0-9-_]+$

• Lowercase letters, numbers, hyphens, and underscores only
• No spaces or special characters
• The name becomes both the directory name and the name field in package.json