Quickstart

IMPORTANT: If you're using an agentic coding solution, you can provide gluelang.dev/llms.txt as a reference, which contains all of these docs in Markdown format.
It will be able to figure out how to bootstrap Glue in your project.

#1. Install Glue

#2. Create a Glue file

Start by creating a Glue file that defines your data models and intefaces using the Glue IDL.
You can also generate code from a URL or from standard input (stdin).

Example:

Glue also support imports, so you can split your models into multiple files and import them:

#3. Generate code

Pick a target (e.g., typescript, python, rust, go, openapi, jsonschema, protobuf) and generate code:

#4. Configure code generation (optional)

To support different use-cases, you can configure code generation with a .gluerc file. For example:

#5. Install VS Code extension (optional)

For a better development experience, install the Glue VS Code extension for syntax highlighting, error diagnostics, hover definitions, go-to definitions and more for Glue files (by default, those ending with .glue).