Repository navigation
Getting Started
This page covers every way to install IronVise 0.8.0. When it is installed, continue with the Quickstart.
| You want | Get it |
|---|---|
| Desktop app (macOS, Windows, Linux) | Installer from the Releases page, or make start from a clone |
CLI and server (ironvise, guard-worker, verify-cert) |
Archive from the Releases page, or build from source |
| Docker image | docker pull ghcr.io/ectospace/ironvise:0.8.0 |
| Python SDK (with LangChain and AutoGen adapters) | pip install ironvise |
| TypeScript / JavaScript SDK | npm install ironvise |
| Windows, from a clone |
.\ironvise-win.ps1 (checks prerequisites, builds, starts the app) |
The v0.8.0 release contains:
| Platform | Desktop app | Command-line tools |
|---|---|---|
| macOS (Apple Silicon) | IronVise_0.8.0_aarch64.dmg |
ironvise-aarch64-apple-darwin.tar.gz |
| Windows (x64) |
IronVise_0.8.0_x64_en-US.msi or IronVise_0.8.0_x64-setup.exe
|
ironvise-x86_64-pc-windows-msvc.zip |
| Linux (x86_64) |
IronVise_0.8.0_amd64.AppImage or IronVise_0.8.0_amd64.deb
|
ironvise-x86_64-unknown-linux-gnu.tar.gz |
SHA256SUMS on the same page lists the SHA-256 of every file. Compare it before you run a download.
The command-line archives contain three programs:
| Program | Purpose |
|---|---|
ironvise |
The CLI and the Observer server (dashboard and REST API) |
guard-worker |
The separate process that runs the semantic guard model |
verify-cert |
The standalone offline certificate verifier. Give this one to auditors. |
-
Windows. The
.msiand.exeinstall the desktop app only. They do not addironviseto PATH. For the command-line tools, unzipironvise-x86_64-pc-windows-msvc.zip(ironvise.exe,guard-worker.exe,verify-cert.exe) and add that folder to PATH, or run the programs by path. -
Linux. The
.deb,.AppImageand CLI archive are built on Ubuntu 22.04 and need glibc 2.35 or newer (Ubuntu 22.04, Debian 12 and later). A binary you compile yourself needs the glibc of the machine that linked it. -
Linux package name. The
.debpackage isiron-vise. It replaces the 0.6.3 packageecto-ledgerinstead of installing beside it. - Desktop requirements. The desktop app runs on macOS 11+, Windows 10+ and Linux.
docker pull ghcr.io/ectospace/ironvise:0.8.0The image runs ironvise serve by default, includes guard-worker and verify-cert, and has a health check (ironvise health).
The image defaults are a demo posture. The published image starts with the semantic guard off (
GUARD_REQUIRED=false), dev mode on (ECTO_DEV_MODE=true) and the dashboard bound to every interface (ECTO_BIND_HOST=0.0.0.0). The server logsWARN INSECURE DEMO MODEwhile any of that is true. Override these for any real use:
docker run --rm \
-e GUARD_REQUIRED=true \
-e GUARD_LLM_BACKEND=ollama -e GUARD_LLM_MODEL="your-review-model" \
-e ECTO_DEV_MODE=false \
-e ECTO_BIND_HOST=0.0.0.0 \
-e DATABASE_URL='postgres://...' \
-p 127.0.0.1:3000:3000 \
ghcr.io/ectospace/ironvise:0.8.0 serveInside a container ECTO_BIND_HOST usually has to stay 0.0.0.0 for the port publish to work, so restrict exposure at the publish level (-p 127.0.0.1:3000:3000) and put TLS and a reverse proxy in front if the dashboard must be reachable from other machines.
For a full demo stack (IronVise, PostgreSQL and a small Ollama model) see Quickstart. To build the image from a checkout without publishing it:
scripts/docker-build.sh --load -t ironvise:localpip install "ironvise>=0.8.0"
pip install "ironvise[langchain]>=0.8.0" # with the LangChain adapter
pip install "ironvise[autogen]>=0.8.0" # with the AutoGen adapter
npm install ironvise@^0.8.0Use 0.8.0 or newer of either SDK. The 0.6.x releases have no verify_intent / verifyIntent, the call that asks permission before an action instead of only recording it. The Python SDK supports Python 3.10 and newer; the TypeScript SDK has no runtime dependencies and works in Node 18+, Deno, Bun and browsers with fetch. Details: SDKs.
Prerequisites:
| Tool | Needed for |
|---|---|
| Rust 1.94+ (edition 2024) | All builds |
| Node.js 20.19+ (22.13+ for the GUI unit tests) | The desktop GUI only |
| Docker | Only the Docker demo stack and the PostgreSQL integration tests |
| A model: Ollama, LM Studio, llama.cpp, vLLM, MLX-LM, LocalAI, or a hosted API key |
audit, orchestrate and red-team
|
macOS and Linux:
git clone https://github.com/EctoSpace/IronVise.git IronVise
cd IronVise
make setup # builds the CLI, installs GUI dependencies, creates .env
make start # opens the desktop appWindows (PowerShell):
git clone https://github.com/EctoSpace/IronVise.git IronVise
cd IronVise
.\ironvise-win.ps1Only the command-line tools:
cargo build --release -p ectoledger # builds ironvise, guard-worker and verify-cert into target/release/The Rust package is still called ectoledger for compatibility; the program it builds is ironvise. The first build compiles the whole workspace and takes a few minutes. Later builds are incremental.
ironvise --version
# ironvise 0.8.0Next: Quickstart.
IronVise, by EctoSpace. Repository | Website | Releases | Report a vulnerability. The server is licensed under BUSL-1.1; the SDKs under Apache-2.0. Compliance mappings are aids, not legal advice or certification.
Get going
Understand
Use
Operate
Project