Kollab
A terminal AI workspace for people who want their agents, tools, providers, plugins, and workflows to share one inspectable runtime.
Getting Started · Providers · Models · Agents · Web UI · Plugins · Hub
Kollab is a terminal-native AI workspace for developers who want more than a single chat box. It brings interactive chat, slash commands, provider profiles, model loadouts, tool permissions, MCP servers, plugins, pipe mode, a local browser UI, and collaborating agents into one CLI.
The point is not to hide the machinery. Kollab gives you a fast daily AI terminal, but it also exposes the runtime underneath it: every meaningful stage is hookable. User input, LLM requests, streamed responses, message display, tool calls, and post-tool results all move through an event pipeline that plugins can observe, transform, or block.
That lets Kollab do things that are still unusual in a terminal AI app: multiple agents can discover each other without a central server, exchange hub messages, carry task ledgers across context compaction, keep vault-backed memory, receive scheduled prompts, search and load tools on demand, preserve oversized tool results as inspectable artifacts, and advertise identity, trust, and capabilities through an experimental Agent DNS layer.
Kollab is still beta, and some of the ambitious pieces are being hardened. But the shape is already there: a local, inspectable AI workspace that can grow from one chat session into a small team of coordinated agents.
What Kollab Does
- Chat with frontier, local, or OpenAI-compatible models from a fast terminal UI.
- Switch providers and model profiles without leaving the session.
- Browse the model registry and activate named loadouts for model, effort, sampling, and output-budget presets.
- Use a ChatGPT subscription through OpenAI OAuth, or bring API keys for other providers.
- Run one-shot prompts and shell pipelines with
kollab -p. - Switch the session workspace at runtime so later file and terminal tools target a different project directory.
- Connect MCP servers for filesystems, GitHub, databases, browsers, search, and custom tools.
- Use built-in
web-searchandweb-fetchtools with smart content extraction and bounded results. - Gate shell, file, and MCP tool use through risk-aware approvals.
- Search and load native or MCP tools on demand instead of injecting every schema into every request.
- Launch specialized agents from bundled, global, or project-local definitions.
- Coordinate multiple terminal agents through the hub: status, messages, task ledgers, vault memory, attach mode, and recurring prompts.
- Keep long-running tasks alive across compaction with checkpoints, QA review, and reminder snoozes.
- Resolve agents by identity, capability, and trust with the experimental Agent DNS layer.
- Start the local engine and assistant-ui browser client together with
kollab --web-ui. - Extend the runtime with Python plugins, slash commands, widgets, XML tool tags, and JSON config hooks.
- Save, resume, inspect, and compact conversations as work evolves.
Why People Notice It
Kollab feels familiar at first: open a terminal, ask for help, use tools, keep working. The difference shows up once the work gets bigger than one prompt.
You can start a coding agent in one terminal, a reviewer in another, and a coordinator in a third. They join a project-scoped mesh automatically through presence files and Unix sockets. You can message them from the TUI or from the shell, attach to their output, assign durable tasks, schedule recurring check-ins, and inspect the memory they carry forward.
The result is a local agent workspace instead of a black-box automation. You can see who is online, what they were asked to do, what they produced, which tools were approved, and which hooks or plugins changed the flow.
Feature Tour
| Area | What you get |
|---|---|
| Terminal chat | Streaming responses, command menu, status layout, themes, widgets, conversation history, and resume |
| Providers and profiles | Anthropic, OpenAI, Google Gemini, Azure OpenAI, OpenRouter, Ollama, LM Studio, and custom OpenAI-compatible endpoints |
| OpenAI OAuth | kollab --login openai for ChatGPT subscription-backed usage without an API key |
| Model registry and loadouts | Catalog metadata, context windows, pricing, provider-aware sampling, reasoning effort, and named /llm presets |
| Pipe mode | git diff | kollab "review this" -p --timeout 5min for scripts, CI, shell workflows, and automation |
| Tool permissions | Approval modes, risk assessment, session/project approvals, blocked tools, trusted tools, and safe wildcard matching |
| Tools and MCP | Native/XML tool parity, workspace-set, web-search/web-fetch, on-demand tool-search/tool-load, project/global MCP configs, and approval-aware external calls |
| Context protection | Aggregate tool-output budgets with lossless .output artifacts and bounded previews when context gets large |
| Agent system | Bundled agents (bundles/agents/), optional local/global agents, Agent Skills modules (bundles/skills/ + .kollab/skills/ + ~/.kollab/skills/), and dynamic prompts |
| Agent hub | Peer discovery, identity/bundle mapping, hub messages, broadcasts, task ledger, checkpoint/snooze/QA flows, output capture, vault memory, cron messages, Telegram bridge, and org launch files |
| Agent DNS | Experimental identity, trust, capability lookup, Ed25519 keys, AID-style TXT export, ARDP-style registration payloads, and DNS roster commands |
| Plugin system | Event hooks, custom commands, startup info, config widgets, XML tags, context injection, and clean shutdown |
| Engine, web UI, and attach mode | Local FastAPI engine, assistant-ui browser client, bearer-token wiring, RPC state services, multi-context daemons, and attach workflows |
Agent Hub
The hub is Kollab's agent collaboration layer. Agents launched in the same project can discover each other automatically, communicate over local sockets, and coordinate through a shared command surface.
Keep these three names separate:
- identity — the stable hub name or mailbox, such as
lapis. It is what/hub status,/hub msg, and/hub captureaddress. - bundle — the behavior package, such as
coderorresearch: system prompt, prompt sections, allowed tools, and declared skills. - provider profile/loadout — the model connection and tuning. A profile owns credentials; a loadout combines a profile with a model and parameters such as effort or output budget.
This launch runs the coder bundle under the lapis identity with the
openai-oauth provider profile:
kollab --agent coder --as lapis --llm openai-oauth
kollab --agent coder --as lapis
kollab --agent technical-writer --as sapphire
kollab --hub status
kollab --hub msg lapis "review the latest diff"
kollab --hub capture lapis 100
Hub features include:
- Zero-config peer discovery for local agents in the same project.
- Optional fixed identities with
--as(for example,--as lapis) when you want stable names instead of auto-assigned identities. - Direct messages, broadcasts, live output capture, and interactive attach mode.
- Durable task ledgers with
active -> done -> QA review -> closedworkflows, including thetask_snoozereminder control. - Vault-backed memory with raw streams, rolling working memory, and crystallized long-term notes.
- Recurring hub messages through
/hub cron. - Optional Telegram forwarding for remote check-ins.
- Organization launch files for starting multi-agent teams.
An offline inbox is durable mail waiting for a known identity; it is not a
live process. capture only works for an online peer or active orchestrator
session, so agent 'lapis' not found means there is no capturable live runtime
under that name. A direct message can still be queued for the identity and
delivered when it reconnects.
research is normally a bundle name, not a hub identity. Capture the identity
shown by /hub status instead.
Agent DNS
Agent DNS is experimental, but it is one of the more forward-looking pieces of Kollab. It adds a discovery, identity, and trust layer on top of the hub so agents can be addressed by more than a process name.
The DNS registry stores agent records with an ARDP-style identity such as
agent:lapis@kollabor.ai, local socket or remote endpoint bindings,
capability entries, public keys, approval state, trust score, and current
runtime state. It can export AID-style TXT records and publish well-known
agent key metadata for interoperability experiments.
/hub dns resolve
/hub dns resolve lapis
/hub dns find review
/hub dns trust lapis
/hub dns leaderboard
/hub dns endorse lapis review
/hub dns keys lapis
/hub dns endpoint
/hub dns connect example.com
Today this is best understood as an emerging trust and routing layer for local agent meshes: resolve who is online, find agents by capability, inspect key material, and track reputation through task outcomes and endorsements.
An optional off-box endpoint (plugins.hub.endpoint_enabled) binds a TCP/TLS
listener that shares the same Ed25519 handshake, so a remote agent on another
machine can authenticate and deliver messages over the network. It is disabled
by default, always requires the handshake, and refuses to bind a plaintext port
without an explicit opt-in. /hub dns connect <authority> imports a remote
mesh's published keys so the inbound handshake can verify it. See
docs/specs/hub-remote-endpoint.md.
Browser UI and Local Engine
The optional browser surface uses the same provider, tool, permission, MCP, and hub runtime as the terminal app. From a source checkout or installed workspace:
kollab --web-ui
# browser: http://127.0.0.1:8080
# engine: http://127.0.0.1:7433
The flag starts the local engine when needed, launches kollabor-webui, reuses a
healthy engine on port 7433, and cleans up child processes on exit. For separate
development loops, see the engine README
and web UI README.
Why It Exists
Most AI CLIs are either chat windows or opaque automations. Kollab aims for the middle ground: a terminal workspace you can actually steer, inspect, and rewire. It is useful as a day-to-day coding chat, but the interesting part is the runtime beneath it: hooks, plugins, agents, permissions, MCP, and durable conversation state all share the same pipeline.
user input -> pre_user_input -> pre_api_request -> [LLM API]
-> post_api_response -> pre_message_display -> output
|
-> pre_tool_use -> tool execution -> post_tool_use
That pipeline is how the hub, permissions, context compaction, MCP, terminal sessions, save/resume workflows, and plugin-provided tools layer onto the same core app.
Status
Kollab is beta software. The CLI, provider integrations, plugin APIs, and agent workflows are usable today, but some advanced runtime, engine, and integration paths are still being hardened. See CHANGELOG.md and docs/release-process.md for release notes and release gates.
Install
Recommended installer:
curl -sS https://raw.githubusercontent.com/kollaborai/kollab/main/install.sh | bash
kollab
Python package managers:
pipx install kollab
pipx is the recommended installer: it puts kollab in its own isolated
virtualenv, which sidesteps a class of startup failure where obsolete
stdlib-backport packages (typing, asyncio, dataclasses, pathlib, ...)
left in a shared interpreter shadow the standard library and crash kollab on
launch. uv tool install kollab isolates the same way.
pip install kollab also works, but installs into the active interpreter and so
inherits whatever is already there:
pip install kollab
Homebrew packaging is prepared separately after a release wheel is published and the formula SHA is available. Maintainer notes live in homebrew-tap/README.md.
Quick Start
New here? Launch Kollab and run /setup — a guided wizard walks you through
picking a provider, entering your API key, choosing a model, optionally testing
the connection, and saving it as your active profile. No env vars or JSON
required. (ChatGPT sign-in delegates to /login; Azure/advanced is configured
in config.json — see docs/providers.md.)
Prefer environment variables? Kollab also auto-detects common provider vars:
| Environment Variable | Provider | Notes |
|---|---|---|
ANTHROPIC_API_KEY / ANTHROPIC_AUTH_TOKEN |
Anthropic | Claude models and Anthropic-compatible gateways |
OPENAI_API_KEY |
OpenAI | GPT models |
GEMINI_API_KEY |
Gemini models | |
OPENROUTER_API_KEY |
OpenRouter | Gateway to many providers |
AZURE_OPENAI_API_KEY |
Azure OpenAI | Requires Azure endpoint and model settings |
export OPENAI_API_KEY="<your-openai-api-key>"
kollab
By default, Kollab starts with the koordinator agent and joins the local hub
mesh, so a plain kollab session is ready for multi-agent coordination.
Provider-specific model env vars are also supported for auto-detected profiles:
export OPENROUTER_API_KEY="<your-openrouter-api-key>"
export OPENROUTER_MODEL="deepseek/deepseek-v3.2"
kollab
Anthropic-compatible gateways can use the Claude Code-style env names:
export ANTHROPIC_BASE_URL="https://api.z.ai/api/anthropic"
export ANTHROPIC_AUTH_TOKEN="<your-token>"
export ANTHROPIC_DEFAULT_OPUS_MODEL="glm-4.7"
kollab
Use /llm inside Kollab to switch models and presets. For more
configuration options, see docs/configuration.md,
docs/providers.md, and
docs/reference/env-vars.md.
You can also define profiles directly from environment variables:
# Pattern: KOLLAB_{PROFILE}_{FIELD}
export KOLLAB_WORK_MODEL=claude-sonnet-5
export KOLLAB_WORK_PROVIDER=anthropic
export KOLLAB_WORK_API_KEY="<your-anthropic-api-key>"
export KOLLAB_WORK_BASE_URL="https://api.anthropic.com"
# Optional tuning fields (TEMPERATURE/TOP_P are ignored on models that
# reject sampling params -- see bundles/data/models.json supports_sampling)
export KOLLAB_WORK_MAX_TOKENS=4096
export KOLLAB_WORK_TEMPERATURE=0.3
export KOLLAB_WORK_TIMEOUT=30
export KOLLAB_WORK_TOP_P=0.95
export KOLLAB_WORK_EFFORT=high
export KOLLAB_WORK_STREAMING=true
export KOLLAB_WORK_SUPPORTS_TOOLS=true
export KOLLAB_WORK_DESCRIPTION="Claude profile for work tasks"
# EXTRA_HEADERS must be valid JSON
export KOLLAB_WORK_EXTRA_HEADERS='{"x-trace-id":"work-session"}'
kollab --llm work
# Persist this env-defined profile to config
kollab --llm work --save
# Persist and set as startup default profile
kollab --llm work --default
# Persist to project-local config instead of global
kollab --llm work --save --local
# Set project-local default profile
kollab --llm work --default --local
Common profile fields:
MODEL, PROVIDER, API_KEY, BASE_URL, MAX_TOKENS, TEMPERATURE,
TIMEOUT (seconds), TOP_P, EFFORT, STREAMING, SUPPORTS_TOOLS, DESCRIPTION,
EXTRA_HEADERS (JSON string).
Resolution order is:
KOLLAB_{PROFILE}_{FIELD} -> KOLLAB_{FIELD} -> config -> defaults.
KOLLAB_{PROFILE}_MODEL is required to create a profile from env vars.
Common Workflows
Use ChatGPT OAuth
kollab --login openai
Kollab opens a browser for authorization, stores the token in local user runtime state, and uses the Responses API with the subscription quota.
Run Pipe Mode
kollab "What is the capital of France?"
echo "Explain this code" | kollab -p
cat document.txt | kollab "summarize this" -p
git diff | kollab "write a concise commit message" -p --timeout 30s
Launch Agents
kollab --agent coder --as lapis
kollab --agent technical-writer --as sapphire --skill readme-writing
Agents can be bundled with the project, installed globally, or defined inside a
workspace under .kollab/agents/. --agent selects the bundle; --as selects
the hub identity. See docs/features/agents.md.
Coordinate Agents With The Hub
kollab --agent coder --as lapis
kollab --hub status
kollab --hub msg lapis "review the latest diff"
kollab --hub capture lapis 100
kollab --hub org engineering "ship the billing flow"
kollab --org engineering
kollab --hub stop lapis
Hub capabilities include identities, project-scoped memory, task ledger workflows, recurring hub messages, optional Telegram forwarding, organization launch files, and experimental DNS-style identity and trust commands. Start with docs/guides/hub-quick-start.md.
Manage Tools And MCP
/permissions
/mcp
/mcp show
/mcp reload
Inside /mcp, press g to toggle the global MCP subsystem, or manage
individual configured servers with the per-server actions.
MCP tools run through the same approval system as native tools. See docs/features/permissions.md and docs/features/mcp.md.
The built-in tool-search and tool-load tools let an agent discover a tool by
keyword and load its full schema only when needed. Large tool results remain
available as managed .output artifacts while the model receives a bounded
preview; see tool-output artifacts.
Extend Kollab
Plugins can register hooks, slash commands, startup info, config widgets, and tool handlers:
from kollabor_plugins import BasePlugin
class MyPlugin(BasePlugin):
async def register_hooks(self):
self.event_bus.register_hook("pre_api_request", self.inject_context)
Plugin entry points live under plugins/, and the plugin SDK lives in
packages/kollabor-plugins. See docs/plugins/overview.md,
docs/plugins/development.md, and
docs/plugins/hooks-reference.md.
Slash Commands
| Command | Description |
|---|---|
/llm |
Switch model loadouts — provider + model + param presets |
/model |
Quick model selection and reasoning effort (/model effort max) |
/agent |
Switch agent definitions when available |
/skill |
Load or unload agent skills when available |
/setup |
Guided provider/profile setup |
/save |
Save conversation output |
/hub |
Manage the agent hub |
/hub dns |
Resolve agents, inspect trust, find capabilities, and show Agent DNS keys |
/terminal |
Manage terminal sessions |
/permissions |
Configure tool approval modes |
/login |
Run provider login flows |
/mcp |
Open the MCP manager |
/resume |
Resume a previous conversation |
/config |
Open the settings editor |
/updates |
Browse recent release notes in the terminal |
/help |
Show available commands |
Type / in the app to see the full command menu. Plugins can add more commands.
Common CLI-only or plugin surfaces:
kollab --help
kollab --doctor # first-run readiness check
kollab --updates # recent changes
kollab --sub list # agent orchestrator sessions
kollab --attach lapis # interactively attach to a live identity
kollab --hub status # hub inspection without a TUI
kollab --web-ui # local engine + browser UI
Repository Layout
Kollab is a Python monorepo. The root package provides the kollab command and
the kollabor/ orchestration layer; reusable runtime pieces live in workspace
packages.
| Package | Role |
|---|---|
| kollabor | CLI startup, application orchestration, commands, LLM coordination |
| packages/kollabor-ai | Providers, profiles, OAuth, prompt rendering, conversation state |
| packages/kollabor-agent | Tool execution, MCP, permissions, file/shell operations, agents |
| packages/kollabor-tui | Terminal rendering, input, widgets, fullscreen views, status UI |
| packages/kollabor-events | Event bus, hook registry, executor, processor, event models |
| packages/kollabor-config | Configuration loading and utilities |
| packages/kollabor-plugins | Plugin framework and SDK |
| packages/kollabor-rpc | RPC protocol and client helpers |
| packages/kollabor-engine | Local engine/backend service |
| packages/kollabor-webui | Web UI package |
| plugins | Concrete built-in plugin implementations |
| bundles | Bundled agents, skills, themes, layouts, and widgets |
Development
git clone https://github.com/kollaborai/kollab.git
cd kollab
uv sync --all-packages --extra dev
uv run python main.py
Focused validation used by the current CI baseline:
uv run python -m pytest \
tests/unit/test_openai_streaming_finish_reason.py \
tests/unit/test_turn_runner_tool_loop.py \
tests/unit/test_hub_project_scope.py \
tests/unit/test_provider_models.py \
tests/unit/test_provider_security.py \
tests/unit/test_gemini_provider.py
uv run python -m ruff check --select E9,F63,F7,F82 kollabor packages plugins tests
uv run python -m py_compile kollabor/cli.py kollabor_cli_main.py plugins/hub/plugin.py
For contribution guidance, see CONTRIBUTING.md. For agent and architecture guidance, see AGENTS.md, CLAUDE.md, and docs/architecture/README.md.
Documentation
- Getting Started
- Configuration
- Provider Profiles
- Models and Loadouts
- Reasoning Effort
- Setup Wizard
- Agent System
- Hub Quick Start
- Tasks and Checkpoints
- Tool Calling
- Attach Mode
- Command Reference
- Engine and Web UI
- Tool-output Artifacts
- Documentation Index
- Telegram Bridge Setup
- MCP
- Permissions
- Plugin Development
- Troubleshooting
- Release Process
Support and Security
- Questions and bug reports: GitHub Issues
- Support expectations: SUPPORT.md
- Vulnerability reporting: SECURITY.md
Do not post API keys, OAuth tokens, private conversation logs, raw transcripts, or local runtime data in public issues.
License
Kollab is licensed under the MIT License.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kollab-0.7.2.tar.gz.
File metadata
- Download URL: kollab-0.7.2.tar.gz
- Upload date:
- Size: 2.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
05654cb797174973e92672f2fd5da7db16c9379df959870a61fb5127d10132ff
|
|
| MD5 |
f675670fb25b0d4ad031bd65909e8ff4
|
|
| BLAKE2b-256 |
8298b4a655de24b767523728a0c8405df3471b00904ca2532e70354d52d5ce9b
|
File details
Details for the file kollab-0.7.2-py3-none-any.whl.
File metadata
- Download URL: kollab-0.7.2-py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de1857c4b24ec60f64774a6778d29d88fe7201b9511bc100db96813d3c40350b
|
|
| MD5 |
696dc858587ec9eed47ef92b779f1aa8
|
|
| BLAKE2b-256 |
15afc4c4dc5d40f56e69911538da008651d0611233e18fee7a1bc66723d6d5cf
|