CLI - Commands - create-endpoint

create-endpoint

Create a custom endpoint from a JSON definition file.

create-endpoint generates a typed endpoint from a JSON definition file instead of introspecting a live table. Use it to recreate an endpoint from a committed endpoint.json. Use it to define an endpoint by hand when you cannot reach the data source at generation time.

Run without installing

pnpm lakeql-cli create-endpoint --from-file ./endpoint.json

Each table that pull generates includes an endpoint.json alongside its other files. That file is a valid input here, so endpoints are reproducible from the definition alone. The config registry is updated by default. Pass --skip-registry to skip it, or --force to overwrite existing files.

Unlike pull and bulk-pull, create-endpoint does not apply a data source's namePrefix. This is by design: create-endpoint builds from a manually authored definition with no live source config to read, whereas pull generates read-only schemas whose names it owns. See Prefix scope for the full rationale.

--from-file <path>

Path to a JSON definition file conforming to the Endpoint_Definition_Format

Property	Value
Type	`string`
Required	Yes

--source-path <path>

Base path for generated code (resolved from the command invocation directory). Files are created in schemas/generated|custom inside this path.

Property	Value
Type	`string`
Required	No
Default	`command invocation directory`

--skip-registry

Skip config registry generation

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

--force

Overwrite existing files without prompting

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