54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
# CxLLM-ARA
|
|
|
|
> CxLLM Augmented Reality Assistant
|
|
|
|
ARKit + RealityKit application that surfaces CxLLM inference results as world-anchored UI for spatial assistant scenarios.
|
|
|
|
[](https://git.cxllm-studio.com/CxAI-LLM/CxLLM-ARA/actions)
|
|
[](LICENSE)
|
|
[](#)
|
|
|
|
## Overview
|
|
|
|
`CxLLM-ARA` is part of the **CxLLM** product family — a layered runtime that
|
|
spans Apple kernel extensions, user-space frameworks, host applications, and
|
|
spatial / web surfaces. This module focuses on **app-arkit** concerns and is
|
|
intentionally narrow so that the CxLLM monorepo can compose targets without
|
|
pulling in unrelated dependencies.
|
|
|
|
## Repository layout
|
|
|
|
- `CxLLM-ARA/` — primary source folder (matches the Xcode group / SwiftPM root).
|
|
- `CxLLM-ARA.xcodeproj` — Xcode project (where applicable).
|
|
- `Makefile` — common entry points (`build`, `test`, `lint`, `clean`).
|
|
- `.github/workflows/ci.yml` — CI pipeline (Xcode build + lint).
|
|
- `docs/` — architecture notes and ADRs.
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Build (defaults to Debug for the host platform):
|
|
make build
|
|
|
|
# Run the full test suite (unit + UI where applicable):
|
|
make test
|
|
|
|
# Static analysis + format check:
|
|
make lint
|
|
```
|
|
|
|
## Versioning
|
|
|
|
This module follows [Semantic Versioning 2.0](https://semver.org/) and is
|
|
released in lock-step with the umbrella **CxLLM** product line. See
|
|
[`CHANGELOG.md`](CHANGELOG.md) for the user-facing change log.
|
|
|
|
## Security
|
|
|
|
Please report security issues per [`SECURITY.md`](SECURITY.md). Do **not**
|
|
open public issues for vulnerabilities.
|
|
|
|
## License
|
|
|
|
Released under the [MIT License](LICENSE) © 2026 CxAI-LLM.
|