Skip to content
XIDL

Install & Quickstart

The XIDL compiler, xidlc, compiles .idl files containing interface definitions into server code, client code, and protocol schemas.

1. Install xidlc

Section titled “1. Install xidlc”
Terminal window
curl --proto '=https' --tlsv1.2 -sSf https://xidl.netlify.app/install.sh | sh

2. Verify the install

Section titled “2. Verify the install”
Terminal window
xidlc --help

3. Generate a first artifact

Section titled “3. Generate a first artifact”
Terminal window
xidlc gen -o out rust your.idl

4. Built-in targets

Section titled “4. Built-in targets”
  • rust
  • rust-axum
  • rust-jsonrpc
  • openapi
  • openrpc
  • typescript
  • typescript-rest
  • go
  • go-rest

See Target Generators for the full list with aliases and typical combinations.

Editor Support

Section titled “Editor Support”

A Visual Studio Code extension provides syntax highlighting, code formatting, and HTTP interface preview. See Editor for installation and details.

Next Steps

Section titled “Next Steps”