Skip to content

Install

This page says what AI-LinkMO needs on the machine, how to install it, and how to start the API, the web UI and the CLI. Working with the data says what to do next.

Only want to ask? Install ktl-docent into any agent you use, by a route from the install page, and ask it about this project, such as where the EU AI Act encoding comes from, and who checked it. It answers from the bundle and says how far each answer has been checked.

AI-LinkMO needs Python 3.11+ and uv, and Node 22 for the web UI.

Terminal window
uv sync --extra test
./ai --help

That is the offline CLI, ready to use. If uv sync needs to compile anything on your machine, or you have upgraded ai-atlas-nexus and need to regenerate the UI’s schema, see docs/install-notes.md.

  1. Start the API (details). It listens on port 8000. Its write endpoints are not authenticated, so keep it on localhost.

    Terminal window
    uv run uvicorn lib.api.server:app --reload
  2. Start the web UI in a second terminal (details). The login in the top corner is a persona picker for the demo, not authentication. Curate mode, which edits records in your own data files, is reached through it.

    Terminal window
    cd lib/frontend
    npm ci
    npm run dev
  3. Try the CLI in a third terminal. Each entity type has its own command, and docs/cli-examples.md lists them all with the flags they share.

    Terminal window
    ./ai -h
    ./ai risk -h

docs/working-with-the-data.md says how to go on from there: bring your own data, compute a crosswalk, search the records, browse them in Datasette, or load the graph into Neo4j.