Orkeon
Get started

Orkeon installs on your machine, whatever your system.

The first trial then runs on a local model, with no API key. For a server, see the Deploy page.

Kama, a toolbox in hand, opens the door of his little house, cardboard boxes stacked around him
By system

Install the CLI

.NET, all systems
dotnet tool install -g Orkeon.Scripting.Cli

Requires the .NET 10 SDK. An .ork.ts script also requires esbuild (npm install -g esbuild); a YAML team does not.

Run this on your workstation.

Two minutes

First trial, on a local model

  1. Install the prerequisites

    Ollama (new tab), installed once. The .NET 10 SDK is only needed for the dotnet tool route.

  2. Download the local model

    ollama pull qwen2.5:1.5b
  3. Install Orkeon

    Or by another install route.

    dotnet tool install -g Orkeon.Scripting.Cli
  4. Create the team, then run it

    The quickstart example has one agent, and its configuration already points to Ollama.

    orkeon quickstart && cd orkeon-quickstart
    orkeon run crew.yaml --mount ./out:/output:rw
    refusedThen the same folder, mounted read-only: the write is refused.
    orkeon run crew.yaml --mount ./out:/output:ro
    file_write [FAIL]: Error: Access denied for '/output/hello.md': required Write, effective ReadOnly. Mounts granting Write: (none).

For your own teams, orkeon init configures the model provider; orkeon doctor says what is missing.

The installation guide (new tab) covers the container, the prerequisites, checksum verification and rolling back to an earlier version.

apt source

Debian and Ubuntu: add the signed source

This block verifies the key’s checksum before installing it, then adds the source for the stable channel (apt guide (new tab)).

sudo apt-get update && sudo apt-get install -y ca-certificates curl
curl -fsSL -o /tmp/orkeon-archive-keyring.gpg \
  https://github.com/Orkeon/orkeon/raw/apt/orkeon-archive-keyring.gpg
echo "0cc5e804e1ee49c50ec5b23145ee7ee65d4834a08b8dc38914674249dfcc6a21  /tmp/orkeon-archive-keyring.gpg" | sha256sum --check
sudo install -m 0644 /tmp/orkeon-archive-keyring.gpg /usr/share/keyrings/orkeon-archive-keyring.gpg
sudo tee /etc/apt/sources.list.d/orkeon.sources > /dev/null <<'EOF'
Types: deb
URIs: https://github.com/Orkeon/orkeon/
Suites: raw/apt/stable/
Include: orkeon orkeon-archive-keyring
Signed-By: /usr/share/keyrings/orkeon-archive-keyring.gpg
EOF
sudo apt-get update

Then:

sudo apt install orkeon orkeon-archive-keyring
Other ways

Container, NuGet package, source

In a container: the image ships the example teams, and the command opens a shell in it.

docker run -it --rm -e ORKEON_ENTRYPOINT=shell ghcr.io/orkeon/orkeon:1.0.0

Take a tag from the releases page (new tab), never latest. The image carries no provenance attestation: on a server, pin it by its digest (@sha256:…).

In your .NET application: dotnet add package Orkeon, and Orkeon.Tools for the built-in tools (NuGet packages (new tab)).

From source: git clone https://github.com/Orkeon/orkeon.git, then dotnet build Orkeon.sln.

Limits
  • The Windows installer (.msi) is unsigned and the macOS archive is not notarized: verify their checksum before running them.
  • The container image carries no provenance attestation.
  • The Homebrew formula is not published yet.