Skip to content

Quickstart

This page preserves the repository-level quickstart that used to live in the root README.md.

Install XIDL

Release installer

macOS and Linux:

curl --proto '=https' --tlsv1.2 -sSf https://xidl.github.io/xidl/public/install.sh | sh

Windows PowerShell:

iwr -useb https://xidl.github.io/xidl/public/install.ps1 | iex

Cargo

cargo install xidlc

Cargo Binstall

cargo binstall xidlc

Generate code

xidlc -l rust -o out your.idl

Built-in targets

  • c
  • cpp
  • rust
  • rust-jsonrpc
  • rust-axum
  • ts / typescript
  • openapi
  • openrpc
  • hir
  • typed-ast