Local Setup
Before running Openlane locally, install the base tooling used across the repository.
Required Tools
Primary Frameworks and Services
Openlane development commonly touches:
| Tool | Used For |
|---|---|
| ent | Schema-driven data modeling |
| atlas and goose | Database migrations |
| gqlgen and gqlgenc | GraphQL server and client generation |
| openfga | Authorization enforcement |
| koanf | Configuration management |
Install Dependencies
From the repository root:
task install:all
IDE Build Tags
The core codebase uses build tags for conditional compilation. Configure your IDE with the cli,test,codegen,examples tags, or functions gated behind them will appear undefined and your language server will flag imports as unused.
- VSCode
- GoLand
Add to .vscode/settings.json:
{
"go.buildTags": "cli,test,codegen,examples"
}
Navigate to Settings > Go > Build Tags and add cli,test,codegen,examples as a comma-separated list.