Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kazzle.com/llms.txt

Use this file to discover all available pages before exploring further.

Environment

Kazzle injects a small set of platform variables into app processes. UI builds only receive values that are explicitly exposed at build time, such as VITE_* variables.

Process variables

VariableDescriptionExample
PORTThe port your process should listen on3000
HOSTThe host to bind to0.0.0.0
KAZZLE_API_KEYAPI key for Kazzle-authenticated CLI and runtime calls from the processkzl_...
KAZZLE_API_URLBase URL for the Kazzle APIhttps://api.kazzle.app
PORT and HOST are always set for processes. KAZZLE_API_KEY is generated when Kazzle can issue an app-scoped key for that process. Your process should bind to HOST:PORT. Kazzle handles preview routing and production domains on top of that.

Sibling component URLs

When an app has multiple components, Kazzle can inject URLs that let one component reach another:
VariableDescription
COMPONENT_{NAME}_URLURL for a sibling component at runtime
VITE_COMPONENT_{NAME}_URLBuild-time sibling URL for Vite-based UI components
The name comes from the component’s name field: uppercased, non-alphanumeric characters become underscores. A sibling named API Server becomes COMPONENT_API_SERVER_URL. These URLs point to the deployed sibling when one exists. Otherwise they point to the current development address for that sibling component.