From ec5516ae57fc7a0a6134258182d3406ec8015e28 Mon Sep 17 00:00:00 2001 From: Ollie Agent Date: Sun, 19 Jul 2026 13:37:49 +0200 Subject: [PATCH] README: move Getting started and Configuration to the top --- README.md | 116 +++++++++++++++++++++++++++--------------------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index bb2ea07..467ce06 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,64 @@ Ollie is an AI agent runtime. A small Go core handles the agent loop, tool dispatch, sandboxing, and multi-backend routing; frontends (terminal, acme, Emacs, KDE, browser) and orchestration (shell scripts, multi-agent workflows, cron) are external. The core is deliberately minimal — capabilities come from composing small pieces rather than building a monolithic framework. +## Getting started + +Clone with submodules: + +```sh +git clone --recurse-submodules https://git.lneely.de/lkn/ollie.git +``` + +Or after cloning: + +```sh +git submodule update --init --recursive +``` + +Build and install (pick one): + +```sh +just # 9P path (recommended): core, 9p, acme, kde, httpgw, webui, emacs +just dbus # D-Bus path (KDE-only): core, ollied, kde, httpgw, webui +``` + +These are mutually exclusive — pick the one that matches your setup. + +Requires [just](https://github.com/casey/just): + +```sh +cargo install just +``` + +See [doc/USAGE.md](doc/USAGE.md) for usage instructions. + +## Configuration + +### Environment: `~/.config/ollie/env` + +``` +OLLIE_BACKEND=openai # ollama | openai | anthropic | copilot | kiro (default: ollama) +OLLIE_OLLAMA_URL= # base URL for Ollama (default: http://localhost:11434) +OLLIE_OPENAI_URL=https://openrouter.ai/api +OLLIE_OPENAI_KEY=sk-or-... +OLLIE_ANTHROPIC_KEY=sk-ant-... +OLLIE_COPILOT_TOKEN=... +OLLIE_KIRO_TOKEN=... # bearer token or sqlite:// path (auto-detected from Kiro CLI if unset) +OLLIE_MODEL=qwen/qwen3-235b-a22b +OLLIE_TOOLS_PATH=~/.config/ollie/tools # directory for tool scripts ({tool} steps) +OLLIE_MEMORY_PATH=~/.config/ollie/memory # directory for memory files (ollie/m) +OLLIE_ELEVATE_SOCKET=${XDG_RUNTIME_DIR}/ollie/elevate.sock # socket path for x/elevate adapter +OLLIE_COMPLETE_BACKEND=ollama # backend for u/complete (required) +OLLIE_COMPLETE_MODEL=qwen3:latest # model for u/complete (required) +OLLIE_ENABLED_BACKENDS=openrouter,kiro # backends available for routing (comma-separated) + +# /route file configuration +OLLIE_ROUTE_BACKEND=ollama # backend for the classifier model +OLLIE_ROUTE_MODEL=qwen3:8b # model that classifies task complexity +``` + +Shell environment variables take precedence over the env file. + ## Repository layout Monorepo with Git submodules. Each submodule has its own Go module (except `el` which is Elisp and `kde` which is C++/Qt). @@ -251,64 +309,6 @@ All of these talk to `org.ollie.SessionManager` over D-Bus using Qt's native bin D-Bus supports socket activation: `ollied` can start on first use and exit when idle. The desktop session manages its lifecycle automatically through a `.service` file — no init scripts, no manual daemon management. -## Getting started - -Clone with submodules: - -```sh -git clone --recurse-submodules https://git.lneely.de/lkn/ollie.git -``` - -Or after cloning: - -```sh -git submodule update --init --recursive -``` - -Build and install (pick one): - -```sh -just # 9P path (recommended): core, 9p, acme, kde, httpgw, webui, emacs -just dbus # D-Bus path (KDE-only): core, ollied, kde, httpgw, webui -``` - -These are mutually exclusive — pick the one that matches your setup. - -Requires [just](https://github.com/casey/just): - -```sh -cargo install just -``` - -See [doc/USAGE.md](doc/USAGE.md) for usage instructions. - -## Configuration - -### Environment: `~/.config/ollie/env` - -``` -OLLIE_BACKEND=openai # ollama | openai | anthropic | copilot | kiro (default: ollama) -OLLIE_OLLAMA_URL= # base URL for Ollama (default: http://localhost:11434) -OLLIE_OPENAI_URL=https://openrouter.ai/api -OLLIE_OPENAI_KEY=sk-or-... -OLLIE_ANTHROPIC_KEY=sk-ant-... -OLLIE_COPILOT_TOKEN=... -OLLIE_KIRO_TOKEN=... # bearer token or sqlite:// path (auto-detected from Kiro CLI if unset) -OLLIE_MODEL=qwen/qwen3-235b-a22b -OLLIE_TOOLS_PATH=~/.config/ollie/tools # directory for tool scripts ({tool} steps) -OLLIE_MEMORY_PATH=~/.config/ollie/memory # directory for memory files (ollie/m) -OLLIE_ELEVATE_SOCKET=${XDG_RUNTIME_DIR}/ollie/elevate.sock # socket path for x/elevate adapter -OLLIE_COMPLETE_BACKEND=ollama # backend for u/complete (required) -OLLIE_COMPLETE_MODEL=qwen3:latest # model for u/complete (required) -OLLIE_ENABLED_BACKENDS=openrouter,kiro # backends available for routing (comma-separated) - -# /route file configuration -OLLIE_ROUTE_BACKEND=ollama # backend for the classifier model -OLLIE_ROUTE_MODEL=qwen3:8b # model that classifies task complexity -``` - -Shell environment variables take precedence over the env file. - ## Development Update all submodules to latest: