Orkeon
Contribute

A useful contribution lowers the cost of trying Orkeon.

Orkeon is a young project: a first usage report, even a short one, counts as much as a fix.

Examples

Add an example team

  1. Choose one of the categories under examples/ (new tab), where the repository publishes its example teams.
  2. Write the team and its README from the template (new tab).
  3. Check it without a model with orkeon run config.yaml --validate, then on a local model. Under examples/, the team file is called config.yaml; in the quickstart example, crew.yaml. orkeon run runs either one.
  4. Open a pull request following the contributing guide (new tab).
  5. For your first one, accept the contributor license agreement (new tab), once per account.
examples/<category>/<nn>-<name>/an example team
config.yaml    # the team: agents, tasks, tools, mounts
usecase.yaml   # the use-case sheet, copied from a neighboring example
README.md      # from the template, in English
data/          # only if the team mounts ./data

To build and test the repository, from your fork, with the .NET 10 SDK:

git clone https://github.com/your-username/orkeon.git && cd orkeon
dotnet restore Orkeon.sln
dotnet build Orkeon.sln --no-restore
dotnet test Orkeon.sln --no-build --filter "Category!=Integration&Category!=Slow"

Under the contributor license agreement, you keep your copyright and grant a license to the project’s maintainer, transferable to the entity that will carry the project.

Limits
  • The contributor license agreement is still a draft, awaiting legal review.
  • Orkeon is maintained by a single maintainer, with no commercial support.
Priorities

The work that comes first

  • Bugs found by running the examples on a local model.
  • MCP interoperability tests against the reference servers.
  • Performance.
  • Documentation, in English and French, updated in the same commit.
Direction

Stability of what exists comes before additions

A new model provider, built-in tool, orchestration mode or memory backend waits until a real need calls for it. Until then, it is written in an .ork.ts file or a plugin, without touching the core.

Channels

Questions and bugs are handled in public

Usage reports, questions, ideas and demos go to Discussions (new tab). A bug is reported in Orkeon’s Issues (new tab); a Studio bug, in those of Orkeon Studio (new tab).

Security

Report a vulnerability privately

Write to contact@orkeon.org, or use GitHub’s private reporting (the repository’s “Security” tab, “Report a vulnerability”). The security policy (new tab) says what to include.