Skip to content
AletheIA Docs
Esc
navigateopen⌘Jpreview
On this page

Install AletheIA

Add the AletheIA operating overlay to a project, configure its boundaries, and verify the installation.

AletheIA is installed as a project operating overlay, not as an autonomous runtime. The overlay gives human and AI collaborators shared instructions, project boundaries, and places for decisions, evidence, handoffs, and learnings.

15–30 minutes Existing or new project No runtime replacement

Before you begin

You need:

  • Node.js 18 or newer;
  • Microsoft Agentic Package Manager (APM) available as apm;
  • a Git repository or project directory;
  • permission to add project-level guidance files;
  • a clean commit before adopting the overlay in an existing project.
node --version
apm --version
git status --short

Choose an adoption path

Install with APM

Download and lock the package

From the project root, install the currently published APM package:

apm install nevitonsantana/AletheIA#v1.0.2-apm --target claude,codex,copilot

This creates apm_modules/AletheIA/ and apm.lock.yaml. Commit the lockfile so collaborators and continuous integration resolve the same package content.

Materialize the operating overlay

Still in the consumer project root, run:

apm run scaffold-overlay

The scaffold refuses to overwrite existing AGENTS.md, CLAUDE.md, .claude/, or ops/ai/ paths. Review conflicts rather than forcing an overwrite by default.

Replace project variables

Find the placeholders in the generated guidance:

grep -r '{{' AGENTS.md CLAUDE.md .claude/settings.json

Replace them with the project name, purpose, stack, and real install, test, lint, build, and development commands. Repeat the check until no placeholder remains.

Write the minimum constitution

Replace the placeholder in ops/ai/constitution/ with four short, source-backed files:

File Minimum answer
mission.md What does this project do, and for whom?
scope.md What is in scope, out of scope, or explicitly undecided?
stack.md Which technologies are used, and which commands validate them?
principles.md Which rules must humans and AI collaborators preserve?

Verify before real work

Confirm the expected surfaces exist and the generated files contain no placeholders:

test -f AGENTS.md
test -d ops/ai/constitution
! grep -r '{{' AGENTS.md CLAUDE.md .claude/settings.json
git diff --check

Then open a fresh runtime session from the project root and ask it to summarize the mission, scope, validation commands, and stop conditions without changing files.

What the overlay adds

project/
├── AGENTS.md
├── CLAUDE.md
├── .claude/
│   ├── settings.json
│   └── rules/
└── ops/ai/
    ├── constitution/
    ├── handoffs/
    ├── reports/
    ├── policies/
    ├── schemas/
    ├── skills/
    └── learnings/

These paths establish shared operating context. They do not grant permissions, install a security sandbox, select a model, or authorize autonomous action.

Runtime-specific setup

Read the runtime adapter references when your environment needs deeper setup detail.

Troubleshooting

APM installs the package, but the overlay is missing

Run apm run scaffold-overlay from the consumer project root. Package download and project materialization are separate by design.

The scaffold reports existing files

Stop and compare the current project guidance with the overlay. Do not use --force until the current state is committed and the overwrite impact is understood.

The runtime ignores the project boundaries

Confirm that you started it from the project root, the adapter file exists, placeholders were replaced, and the constitution contains concrete project facts rather than template prose.

A command in the generated guidance is wrong

Correct the project-local variable or adapter. The overlay must point to the repository’s real validation commands; it must not invent replacements.

Installation acceptance check

The installation is ready for a first low-risk slice when:

  • the overlay paths exist;
  • no template variable remains;
  • mission, scope, stack, and principles describe the real project;
  • the selected runtime can summarize those boundaries;
  • no write, permission, or security capability is being inferred from installation alone.

Next steps

Was this page helpful?