Skip to content
axintdocs

Install

Axint ships as a single scoped npm package: @axint/compiler. It bundles the CLI, the MCP server, and the authoring SDK in one install.

If you still see legacy package names like @axintai/compiler or axintai, use the current package names instead. The migration note is here: Migrating from axintai →

Global install

Section titled “Global install”
Terminal window
npm install -g @axint/compiler

After install, the axint binary is on your path:

Terminal window
axint --version
axint --help

Per-project install

Section titled “Per-project install”

If you’d rather pin Axint to a specific project, install it locally and invoke it through your package manager:

Terminal window
npm install --save-dev @axint/compiler
npx -y -p @axint/compiler axint compile intents/SendMessage.intent.ts

Pinning to an exact version is recommended while the compiler is pre-1.0 — the IR schema is stable but diagnostic codes are still growing. Grab the current version from npm view @axint/compiler version and pin it in your package.json:

package.json
{
  "devDependencies": {
    "@axint/compiler": "0.5.2"
  }
}

Using it as a library

Section titled “Using it as a library”

You can also import compileSource() and the SDK directly from your own TypeScript code — this is how axint.ai powers its server-backed playground.

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


const intentSource = `
import { defineIntent, param } from "@axint/compiler";


export default defineIntent({
  name: "LogWorkoutIntent",
  title: "Log Workout",
  description: "Records a workout session.",
  domain: "health",
  params: { activity: param.string("Activity type") },
});
`;


const result = compileSource(intentSource, "log-workout.ts");
console.log(result.output?.swiftCode);

Deprecated: the unscoped axint package

Section titled “Deprecated: the unscoped axint package”

Early releases published to the unscoped axint name on npm. That package is permanently deprecated — it will not receive updates. If you see:

Terminal window
npm install -g axint    # ← deprecated, do not use

in older tutorials, replace it with the scoped name.

Next steps

Section titled “Next steps”

move from docs to workflow

After install, choose the shortest next step

Most readers do not need more installation theory. They need the next step: compile something, run Cloud Check, or open a concrete example.

QuickstartCompile the first intent and see the full build → check path in a few minutes.Run Cloud CheckTurn a generated Apple feature into a result once the local compile loop is working.ExamplesUse the examples guide when you want public install and compatibility references.Registry compatibilityOpen the public compatibility page when you need more than installation copy.