CLI - Overview - Installation

Installation

Install the LakeQL CLI in your project.

Install @lakeql/cli as a development dependency. It is a build-time tool, not a runtime dependency.

pnpm add -D @lakeql/cli

This provides the lakeql-cli binary. Run it through your package manager:

Run without installing

pnpm lakeql-cli init

If you scaffolded with create-app, the CLI is already installed and a lakeql.config.ts already exists.

The CLI reads lakeql.config.ts and connects to your data source, so it needs your environment set. Pass --env to load an env file before the config is read.