Installation

There are multiple ways to install ArchiTXT:

• Using a Python package manager (Recommended) – Use pip, Poetry, PDM, uv, or another tool.

• Installing the development version – Get the latest updates from GitHub.

• Using a container – Run ArchiTXT in a Docker or Podman container.

Python Installation

“There’s a snake in my boot!”

—Woody, Toy Story

ArchiTXT is available as a python package on PyPI (pypi.org/project/architxt). You can install it using any Python package manager of your choice. It requires Python 3.10+, to check your Python version, run:

Unix/macOS

$ python3 --version

Windows

$ py --version

If you don’t know about Python packaging, you can read the official guide.

Stable Release (Recommended)

To install the latest stable release of ArchiTXT, use one of the following methods:

pip

$ pip install "architxt"

To install a specific version

$ pip install "architxt==<version>"

Poetry

$ poetry add "architxt"

To install a specific version

$ poetry add "architxt==<version>"

PDM

$ pdm add "architxt"

To install a specific version

$ pdm add "architxt==<version>"

uv

$ uv add "architxt"

To install a specific version

$ uv add "architxt==<version>"

Development Version

To install the latest development version directly from GitHub:

$ pip install git+https://github.com/Neplex/ArchiTXT.git

This version may include new features and bug fixes that have not yet been released.

Container Installation

ArchiTXT is also available as a pre-built container image.

Docker

Pull the latest Docker image:

$ docker pull ghcr.io/neplex/architxt:latest

Start the UI:

$ docker run -d \
    -e CORENLP_URL=http://corenlp-uri:9000 \
    -p 8080:8080 \
    --name architxt \
    ghcr.io/neplex/architxt:latest

Use the CLI directly:

$ docker run --rm \
    -e CORENLP_URL=http://corenlp-uri:9000 \
    --name architxt \
    ghcr.io/neplex/architxt:latest \
    --help

Podman

Pull the latest Podman image:

$ podman pull ghcr.io/neplex/architxt:latest

Start the UI:

$ podman run -d \
    -e CORENLP_URL=http://corenlp-uri:9000 \
    -p 8080:8080 \
    --name architxt \
    ghcr.io/neplex/architxt:latest

Use the CLI directly:

$ podman run --rm \
    -e CORENLP_URL=http://corenlp-uri:9000 \
    --name architxt \
    ghcr.io/neplex/architxt:latest \
    --help

Compose

services:
    architxt:
        image: ghcr.io/neplex/architxt:latest
        ports:
            - "8080:8080"
        environment:
            CORENLP_URL: http://corenlp-uri:9000

---

Once installed, you’re ready to Get Started!