Lombok Documentation
This guide gives you the essentials for using Lombok, from the first install to configuration and the app platform.
Requirements
Section titled “Requirements”Make sure you have the following installed:
- Node.js 18 or later
- Bun 1.1 or later
- An active Lombok workspace
[!NOTE] The docs site is generated with Starlight, so you can browse it locally while the content is still evolving.
Install the package
Section titled “Install the package”Run the following command in your project directory:
bun installConfigure
Section titled “Configure”Set your environment variables before running the docs or the app platform locally:
export LOMBOK_API_KEY=your_api_key_hereWhat’s next?
Section titled “What’s next?”Read the Quickstart to create your first Lombok workspace.
Configuration options
Section titled “Configuration options”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| apiKey | string | Yes | — | Your Lombok API key. |
| baseURL | string | No | https://api.lombokapp.com | API base URL. |
| timeout | number | No | 10000 | Request timeout in ms. |
| retries | number | No | 3 | Number of retry attempts. |