Airalogy is the monorepo for the Airalogy protocol ecosystem:
packages/pypi/airalogy: Python protocol core, AIMD parsing, validation, models, records, and CLI.packages/pypi/airalogy-engine: Python protocol execution sandbox package.packages/npm/aimd-*: TypeScript AIMD parser, renderer, editor, and recorder packages.packages/npm/airalogy-engine: Node.js protocol execution sandbox package.packages/runtime/airalogy-engine-image: sandbox image definition used by engine packages.apps/protocol-demo: local Airalogy Protocol demo backed by the Node.js engine package.examples/aimd: standalone AIMD examples for browser preview and recorder demos.examples/protocols: complete official Airalogy Protocol examples migrated from the former standaloneairalogy/protocolsrepository.spec/fixtures: shared protocol fixtures for cross-implementation compatibility.
| Package | Registry | Source | Summary |
|---|---|---|---|
airalogy |
packages/pypi/airalogy |
Python protocol core, AIMD parsing, validation, records, and CLI | |
airalogy-engine |
packages/pypi/airalogy-engine |
Python protocol execution sandbox API | |
@airalogy/aimd-core |
packages/npm/aimd-core |
TypeScript AIMD parser, syntax definitions, and utilities | |
@airalogy/aimd-editor |
packages/npm/aimd-editor |
Monaco editor integration and Vue authoring workflows | |
@airalogy/aimd-renderer |
packages/npm/aimd-renderer |
AIMD rendering to HTML and Vue | |
@airalogy/aimd-recorder |
packages/npm/aimd-recorder |
Vue UI components for structured AIMD recording | |
@airalogy/airalogy-engine |
packages/npm/airalogy-engine |
Node.js protocol execution sandbox API |
Python package commands run from their package directories:
cd packages/pypi/airalogy
uv sync --locked --all-extras --dev
uv run pytest tests/cd packages/pypi/airalogy-engine
uv sync --locked --dev
uv run pytest tests/ --sandbox-mode=rootfsnpm package commands run from the repository root:
pnpm install
pnpm build:npm
pnpm type-check
pnpm testRun the full local protocol demo with a Docker-built engine rootfs:
pnpm dev:protocol-demo:full- Docs home:
docs/home - Airalogy Python package docs:
docs/airalogy - AIMD npm package docs:
docs/aimd - Airalogy Engine docs:
docs/airalogy-engine - Official protocol examples:
examples/protocols
Published docs are assembled into one GitHub Pages site:
- https://airalogy.github.io/airalogy/
- https://airalogy.github.io/airalogy/zh/
- https://airalogy.github.io/airalogy/airalogy/
- https://airalogy.github.io/airalogy/aimd/
- https://airalogy.github.io/airalogy/airalogy-engine/
- Published packages are versioned with Changesets.
- npm packages publish from
packages/npm/*through npm Trusted Publishing. - PyPI package versions are anchored by private
package.jsonfiles, synced topyproject.toml, and published through PyPI Trusted Publishing.
If Airalogy or the AIMD packages are useful in your work, please cite the Airalogy paper:
@misc{yang2025airalogyaiempowereduniversaldata,
title={Airalogy: AI-empowered universal data digitization for research automation},
author={Zijie Yang and Qiji Zhou and Fang Guo and Sijie Zhang and Yexun Xi and Jinglei Nie and Yudian Zhu and Liping Huang and Chou Wu and Yonghe Xia and Xiaoyu Ma and Yingming Pu and Panzhong Lu and Junshu Pan and Mingtao Chen and Tiannan Guo and Yanmei Dou and Hongyu Chen and Anping Zeng and Jiaxing Huang and Tian Xu and Yue Zhang},
year={2025},
eprint={2506.18586},
archivePrefix={arXiv},
primaryClass={cs.AI},
url={https://arxiv.org/abs/2506.18586},
}The former standalone aimd and airalogy-engine repositories are intended to become archived mirrors after this monorepo migration lands.