System requirements & release status

Check platform support and choose a system profile for the features you want to use. Use the public Download page to see approved releases and published platforms.

Platforms

System requirements

The minimum profile uses a cloud model while Orek runs the agent loop and tools on your machine. Indexing, automatic retrieval, and local models are off. The recommended profile adds Shieldstral (a local model that reviews commands before they run), local models run with llama.cpp for code search embeddings and optional reranking, code indexing and retrieval, and MCP connections.

These are starting recommendations, not tested hardware limits.

Download the application and model files before working offline. See Prepare a disconnected workstation for a fully local setup.

Storage figures exclude your project, build tools, and dependencies. The bundled embedding, reranking, and Shieldstral model files total about 2.9 GiB, not counting the memory they use while running or your code indexes. A local model that writes code is separate from these bundled helper models and needs more memory and storage, depending on the model you choose. See Local models.

Recommended GPUs

These are the minimum recommended GPUs for Shieldstral and the bundled embedding and reranking models. These models also run on the CPU, but a capable GPU keeps them fast and responsive.

Larger local coding models, such as Qwen 3.8, need a separate, substantially more powerful GPU setup with more VRAM or unified memory. Size that setup for the specific model variant, quantization, and context length; the helper-model baselines above are not a recommendation for running those models.

Orek’s packages include everything the helper models need to use the GPU: Metal on Apple Silicon Macs, and Vulkan on Windows and Linux for NVIDIA, AMD, and Intel graphics. Keep your graphics driver up to date; no separate GPU toolkit is needed. On Linux, install libvulkan1 and your graphics driver’s Vulkan support. Without a compatible GPU or driver, the helper models run on the CPU. GPU acceleration is supported on Windows PCs with AMD graphics and experimental on other systems. See GPU acceleration to check which GPU Orek uses or to choose one.

Minimum profile settings

To use the minimum profile, select cloud models for your conversation and any subagents, then save these settings in your user configuration:

[exec]
default_approval_mode = "default"

[index]
enabled = false

[index.retrieval]
enabled = false

The default approval mode uses approval prompts instead of the local Shieldstral reviewer. See Configuration for the user configuration file location and MCP servers for connecting additional tools.

Current release limitations

Reporting issues

Use /support inside Orek for the contact link and local report instructions. /feedback prepares a local report with a report ID, rating, category and only the comment you enter. The shell equivalent is:

orek feedback --rating negative --category reliability --comment "Describe what happened"

Diagnostic bundles use the standalone recovery command orek bug-report; /support shows these preview/save commands inside the TUI. Preview the report locally, then save it if you want to share it:

orek bug-report
orek bug-report --include-log --output report.json

The preview includes Orek version, compiled source identity, OS/architecture and any pending minimal crash envelope. Logs are opt-in. You can explicitly include an existing doctor-output file with --doctor-output doctor.txt; the report command does not run diagnostic probes itself.

Review the exact preview before contacting support. Include the report ID, your installation method, reproduction steps and expected result. Copy only the details you choose into the contact form. Orek does not submit the report or attach files for you, and does not collect product telemetry.

The shared diagnostic redactor masks recognizable secrets, URL details and home paths. It cannot decide which project information is private, so review all text. Inputs larger than 1 MiB, invalid UTF-8 and unreadable files are omitted. Included inputs are redacted in full before their last 32 KiB is selected.

A panic saves only a minimal local crash envelope, never its message, backtrace, command, environment or conversation. The next launch offers a preview; no network request is made by the crash hook. orek bug-report --clear-crash discards the pending envelope. Only the latest envelope is kept; files you save for support stay under your control.

See Troubleshooting & diagnostics for local investigation and optional export to your own OpenTelemetry collector.