Documentation

Everything you need to install, configure, and use Clank.

📦

Install Guide

Install Clank, set up local models, configure cloud providers, connect Telegram and Discord.

📖

User Guide

Day-to-day usage — agents, sub-agents, background tasks, Telegram commands, configuration reference.

📋

Changelog

Complete release history with every feature, fix, and improvement.

🔒

Security Policy

Security model, reporting vulnerabilities, and what to expect from Clank's access model.

Quick Start

npm install -g @clanklabs/clank
clank setup
clank

Setup auto-detects your local models, configures the gateway, and gets you chatting in under 2 minutes.

Security Notice: Clank gives AI agents full access to your file system, shell, and connected services. We strongly recommend running it on dedicated hardware (dev machine, VM, or container) rather than on systems with sensitive personal data.

Providers

Clank supports 8 providers. Mix and match for different agents.

ProviderExample ModelAuth
Ollamaollama/qwen3.5Local
Anthropicanthropic/claude-sonnet-4-6API Key
OpenAIopenai/gpt-4oAPI Key
Googlegoogle/gemini-2.0-flashAPI Key
OpenRouteropenrouter/meta-llama/llama-3.1-70bAPI Key
OpenCodeopencode/claude-sonnet-4-6API Key
Codexcodex/codex-mini-latestOAuth
llama.cppllamacpp/model-nameLocal

Telegram Commands

CommandAction
/newStart a fresh session
/resetClear session history
/statusAgent, model, tasks, uptime
/agentsList agents with models
/agent <name>Switch agent
/tasksShow background tasks
/kill <id>Kill a task
/killallKill all tasks
/thinkToggle thinking display
/modelShow model + fallbacks
/versionShow version

CLI Reference

CommandDescription
clankStart gateway + TUI
clank chatDirect CLI chat
clank dashboardOpen Web UI
clank setupRun setup wizard
clank gateway start|stop|restartManage gateway
clank auth login|status|logoutOAuth credentials
clank models listList models
clank agents listList agents
clank daemon install|uninstallSystem service
clank fixRun diagnostics
clank updateUpdate Clank