Skip to content

Installation

Prism is available as a Windows installer (recommended for end users) or via uv/pip for Linux and development setups.

  1. Download the latest installer from GitHub Releases:

  2. prism-<version>-setup.exe — Inno Setup installer. Installs prism.exe to C:\Program Files\prism\ and adds that folder to the system PATH.

  3. prism.exe — Standalone PyInstaller binary. Drop it anywhere on your PATH — no install needed.

  4. Run the installer. You'll be prompted for admin rights (needed to modify the system PATH and write under Program Files).

  5. Open a new terminal (PowerShell, Command Prompt, or Windows Terminal). The existing terminal sessions won't have the new PATH yet — that's why a fresh window is required.

  6. Verify by asking Prism to show its help, then hit the server you plan to use:

    prism --help
    prism info
    

    If prism info fails with a connection error, that's expected — you haven't told Prism where IRIS lives yet. Continue to Configuration or the Quick Start.

Linux (development / pip)

Prerequisites

  • Python 3.12+
  • uv (recommended) or pip
  • A reachable IRIS instance with the Atelier REST API enabled

Install with uv

# Clone the repo
git clone https://github.com/AdriaERNI/Prism.git
cd Prism

# Install all dependencies (creates a virtualenv)
uv sync

# Verify
uv run prism --help
uv run prism info

Install with pip

pip install prism

# Verify
prism --help
prism info

TOON output format

TOON is included by default. Use it with:

prism --format toon info

Standalone executable (Windows)

If you'd rather not run an installer, grab the standalone prism.exe from GitHub Releases. It's a fully self-contained PyInstaller bundle with the Prism logo icon — drop it anywhere on your PATH (or invoke it with a full path).

prism-0.2.1-beta2.exe --help

Uninstall

Windows: Settings → Apps → Installed apps → Prism → Uninstall, or run unins000.exe inside C:\Program Files\Prism\. The uninstaller also removes Prism from the system PATH.

Linux: pip uninstall prism or remove the cloned directory.

Prerequisites

The only runtime requirement is a reachable IRIS instance with the Atelier REST API enabled. The SuperServer port (default 1972) should also be reachable for the native prism terminal command; if it isn't, prism ws uses the Atelier WebSocket instead.

Next steps

  • Quick Start — a five-minute tour of the CLI.
  • Configuration — save your IRIS credentials once with prism config.
  • MCP Server — when you want Claude Code, Claude Desktop, or any other MCP client to drive Prism for you.