Skip to content

Latest commit

 

History

History
126 lines (88 loc) · 3.43 KB

README.md

File metadata and controls

126 lines (88 loc) · 3.43 KB

iii-console

Developer and operations console for the iii engine.

License

Built as a standalone binary that embeds a React frontend and connects to the iii engine via HTTP, WebSocket, and SDK connections.

Install

curl -fsSL https://install.iii.dev/console/main/install.sh | bash

Specific version:

curl -fsSL https://install.iii.dev/console/main/install.sh | bash -s -- -v 0.1.5

Custom directory:

INSTALL_DIR=/usr/local/bin curl -fsSL https://install.iii.dev/console/main/install.sh | bash

The script auto-detects your platform, downloads the correct binary, verifies the SHA256 checksum, and adds it to your PATH.

Manual download

Download the latest release binary from the Releases page.

Platform Target
macOS (Apple Silicon) aarch64-apple-darwin
macOS (Intel) x86_64-apple-darwin
Linux (x86_64, glibc) x86_64-unknown-linux-gnu
Linux (x86_64, musl) x86_64-unknown-linux-musl
Linux (ARM64) aarch64-unknown-linux-gnu

Each release includes .sha256 checksum files for verification.

macOS Gatekeeper

macOS blocks unsigned binaries downloaded from the internet. Remove the quarantine attribute:

xattr -d com.apple.quarantine ./iii-console

Usage

iii-console [OPTIONS]

Options

Flag Description Default
-p, --port <port> Console UI port 3113
--host <host> Host to bind the console server to 127.0.0.1
--engine-host <host> iii engine host 127.0.0.1
--engine-port <port> Engine HTTP API port 3111
--ws-port <port> Engine WebSocket port 3112
--bridge-port <port> Engine bridge WebSocket port 49134
--no-otel Disable OpenTelemetry tracing, metrics, and logs export false
--otel-service-name <name> OpenTelemetry service name iii-console
--enable-flow Enable the flow visualization page false

Environment variables

Variable Description
OTEL_DISABLED Disable OpenTelemetry (same as --no-otel)
OTEL_SERVICE_NAME OpenTelemetry service name (same as --otel-service-name)
III_ENABLE_FLOW Enable flow visualization (same as --enable-flow)

Development

This is a pnpm monorepo with two packages:

  • packages/console-frontend/ - React/TypeScript frontend (Vite + TanStack Router)
  • packages/console-rust/ - Rust binary (Axum server + iii SDK bridge)

Prerequisites

  • Node.js 22+
  • pnpm 10+
  • Rust (stable)

Frontend development

pnpm install
pnpm run dev       # dev server with hot reload (port 5173)
pnpm run lint      # lint and format

Rust binary

pnpm run build       # build everything (frontend + binary)
pnpm run build:rust  # build binary only (skips frontend rebuild)
pnpm run start:rust  # run the binary

Testing with iii-example

The repo includes iii-example/ for local testing. Run in separate terminals:

# Terminal 1 - iii engine
cd /path/to/iii-engine
cargo run --release -- --config /path/to/iii-console/iii-example/config.yaml

# Terminal 2 - Example app
cd iii-example && pnpm install && pnpm start

# Terminal 3 - Console
./iii-console

Requires Redis on localhost:6379.

License

Apache 2.0