LakeQL
Introduction
  • Overview
  • Why LakeQL
  • Key Concepts
Getting Started
  • Prerequisites
  • Quickstart
  • Environment
  • First Run
Architecture
  • System Overview
  • Data Flow
  • Request Lifecycle
Configuration
  • Config File
  • Runtime Lifecycle
  • Environment Variables
create-app
  • Usage
  • Template Structure
  • Post-Creation
Guides
  • Custom Resolvers
  • Extending the Schema
  • Mutations
  • Set Up a Trino Mutation
  • Deploying
Endpoints
  • Definition Format
  • Field Types
  • Nested Fields
  • Mutations
  • Glossary
Contributing
  • Local Development
  • Contribution Guide
  • Architecture
GitHub
LakeQL
  1. LakeQL
  2. create-app

create-app

Scaffold a new LakeQL project with create-app.

@lakeql/create-app scaffolds a ready-to-run LakeQL project. It generates the config, the server entry point, auth and permission stubs, and the project structure. You start from a working application instead of a blank directory.

pnpm create @lakeql/app my-api

It prompts for the adapters, data source names, and authentication strategy, or you pass them as flags. This section covers usage, the template structure it generates, and what to do after creation.

create-app is independent of the CLI. It is a one-time scaffolding tool (binary create-lakeql-app); the CLI (lakeql-cli) is the ongoing generation and introspection tool you use inside the project.

Usage

Run create-app interactively or with flags.

Template Structure

What create-app generates.

Post-Creation

What to do after scaffolding a project.

Previous page

Environment Variables

Next page

Usage