Skip to content

Getting started

Ship your first intent.

The fastest path is: scaffold, define one intent, compile it, then optionally publish it to the Registry once the output looks right.

01 · section

Start with a scaffold

axint init gives you a ready-to-compile project skeleton. That keeps your publish metadata, README, and source structure aligned from the start.

Scaffold a project
$ axint init my-intent
$ cd my-intent
02 · section

Minimal intent definition

You can write in TypeScript or Python. The Registry accepts both, and package pages can show both when they are included.

TypeScript
import { defineIntent, param } from "@axint/compiler";

export default defineIntent({
  name: "CreateEvent",
  title: "Create event",
  params: {
    title: param.string("Event title"),
    startsAt: param.date("When it starts"),
  },
});
03 · section

Compile and validate

Compile first. Publish second. The Registry works best when package pages already reflect a clean local compiler run.

  • Inspect the generated Swift before you publish.
  • Fix diagnostics locally so the published package already feels production-grade.
Compile
$ axint compile src/intent.ts