Skip to content

AIX file format

AIX is an executable package format for AI.

It packages pages, schema, and tools into a distributable artifact for AI agents.

Package Structure DemoInteractive example of how an `.aix` artifact stays readable.

Reading model

Readable from the start.

The homepage should immediately tell readers what the package contains, how those files define pages, and how schema expands that structure into runtime-facing surfaces.

Package structure

AIX keeps the package readable as a tree of concrete entries instead of collapsing everything into an opaque blob.

Page metadata

App and page config files define navigable surfaces and carry the context needed to interpret the package.

Schema to tools

Schema-bearing pages can be promoted into tool-facing contracts without losing the link back to the package.

How readers interpret AIX

From package to tool.

01

Open the archive

Readers start with the package boundary and enumerate entries such as `VERSION`, `app.json`, page files, and assets.

02

Resolve pages

Page config and single-file components are interpreted into page summaries, descriptions, and layout hints.

03

Interpret schema

Schema data adds explicit contracts to those pages so the package becomes more than a file container.

04

Derive tools

Tool descriptions can then be generated from the same package-native structure rather than reconstructed elsewhere.

Core package

The `aix` crate defines the AIX format itself. It provides the package reading model, page analysis logic, and the structural semantics that every other tool in the repository builds on.

Use it when you need the canonical library surface for reading `.aix` packages, resolving page metadata, or deriving format-native structures in Rust.

Quick command
cargo test -p aix

CLI package

The `aix-cli` crate turns the format model into terminal workflows. It is the command-line entry point for packaging, validating, and inspecting `.aix` artifacts.

Use it when you want to work with AIX from automation scripts, local development, or release pipelines without embedding the format library directly.

Quick command
cargo run -p aix-cli -- --help

Web package

The `aix-web` crate makes the same format capabilities available in the browser. It exposes AIX through WASM bindings and supports interactive inspection surfaces such as the Package Lab.

Use it when AIX needs to be explored, demonstrated, or integrated into web-based environments without leaving the format model behind.

Quick command
cargo check -p aix-web --target wasm32-unknown-unknown

AIX file format documentation and package lab.