CLI - Commands

The CLI commands fall into three kinds. Project setup (init, add) scaffolds and extends a project. Introspection (the list-* commands) explores a data source. Generation (pull, create-endpoint, create-registry, generate-import-config) writes the typed endpoint files.

Each command's arguments and options come from the CLI's own metadata, so they always match the installed version.

Every command accepts the global --env [path] option to load environment variables from a file before running (defaults to .env when given without a value).

init

Initialize a LakeQL config file in the current project.

pull

Interactively generate a query endpoint from a remote table.

create-registry

Regenerate the config registry that keeps createPermission type-safe.

create-endpoint

Create a custom endpoint from a JSON definition file.

generate-import-config

Generate an import.config.mjs from already-pulled schemas.

list-schemas

List the schemas available in a catalog.

list-tables

List the tables available in a schema.

list-views

List the views available in a schema.

list-columns

List the columns of a table.

add

Apply a named feature template to the current project.