LakeQL - create-app - Usage

Usage

Run create-app interactively or with flags.

Run the scaffolder through your package manager's create command:

pnpm create @lakeql/app my-api

Run without answers, and it prompts for the project name, the adapters to include, the data source names, and the authentication strategy. Every prompt has a corresponding flag, so you can run it non-interactively in scripts. For example:

pnpm create @lakeql/app my-api --adapters trino,fabric --auth entra-id

The arguments and options below come from create-app's own metadata, so they always match the installed version.

Arguments

Name	Description	Required
`[project-name]`	Project directory name	No

--adapters <ids>

Comma-separated adapter IDs (trino, fabric)

Property	Value
Type	`string`
Required	No

--ds-names <names>

Comma-separated data source names (same order as --adapters)

Property	Value
Type	`string`
Required	No

--auth <strategy>

Authentication strategy

Property	Value
Type	`string`
Choices	`mockentra-idcustom`
Required	No

-d, --target-dir <path>

Parent directory to create the project in (default: current directory)

Property	Value
Type	`string`
Required	No

-p, --package-manager <pm>

Package manager: npm, pnpm, yarn

Property	Value
Type	`string`
Required	No

--no-install

Skip dependency installation

Property	Value
Type	`boolean`
Required	No

--dry-run

Preview generated files without writing

Property	Value
Type	`boolean`
Required	No
Default	`false`

--local [path]

Dev mode: scaffold from a local template dir (default: <cwd>/templates/app) and keep workspace:* dependency versions

Property	Value
Type	`string`
Required	No

-q, --quiet

Suppress all output

Property	Value
Type	`boolean`
Required	No