# Claway

> Claway is Blockway's AI agent for teams. It runs on a Claway Box (on-premises appliance) or as a hosted Claway tenant, is managed from the OPS dashboard, chats on WhatsApp, Telegram, Slack, Teams and other messaging platforms and in the Claway App, and connects to n8n, Zapier or your own software through webhooks and an OpenAI-compatible API.

Support: support@claway.io

## Getting Started

- [Getting started with Claway](https://docs.claway.io/getting-started): Claway Box or hosted Claway: first login to OPS, connecting messaging platforms, and wiring Claway into n8n or your own software.

## Connect your apps

- [Webhooks (n8n, Zapier, Make)](https://docs.claway.io/user-guide/messaging/webhooks): Call the agent from n8n, Zapier, Make or your own code over HTTP, and trigger agent runs from GitHub, GitLab and other services
- [API Server (OpenAI-compatible)](https://docs.claway.io/user-guide/features/api-server): Use your Claway agent through an OpenAI-compatible API: n8n AI nodes, Open WebUI, LobeChat and any OpenAI SDK
- [Open WebUI](https://docs.claway.io/user-guide/messaging/open-webui): Connect Open WebUI to Claway Agent via the OpenAI-compatible API server
- [Programmatic Integration](https://docs.claway.io/developer-guide/programmatic-integration): Three protocols for driving claway from external programs: ACP, the TUI gateway JSON-RPC, and the OpenAI-compatible HTTP API

## Operators and end users

- [Operator Guide](https://docs.claway.io/operators): Everything the person who runs Claway for a team needs to know.
- [Operator: Getting Started](https://docs.claway.io/operators/getting-started): First login, TOTP setup, and a page-by-page tour.
- [Persona Guide](https://docs.claway.io/operators/persona-guide): How to write a persona that holds up in production, and how the AI Assist helper works.
- [Knowledge Base Guide](https://docs.claway.io/operators/kb-guide): Uploading documents, per-chat scoping, and the security model that keeps groups isolated.
- [WhatsApp Group Onboarding](https://docs.claway.io/operators/whatsapp-onboarding): The five-step wizard for bringing a new group online without editing config.yaml by hand.
- [End-user Cheat Sheet](https://docs.claway.io/end-users): One page per persona — hand these to the people who chat with Jarvis daily.
- [Claway App](https://docs.claway.io/user-guide/employee-app)

## Using the claway CLI

- [CLI](https://docs.claway.io/user-guide/cli): Master the Claway Agent terminal interface — commands, keybindings, personalities, and more
- [TUI (Ink terminal UI)](https://docs.claway.io/user-guide/tui): Launch the modern terminal UI for Claway — mouse-friendly, rich overlays, and non-blocking input.
- [Configuration](https://docs.claway.io/user-guide/configuration): Configure Claway Agent — config.yaml, providers, models, API keys, and more
- [Configuring Models](https://docs.claway.io/user-guide/configuring-models)
- [Sessions](https://docs.claway.io/user-guide/sessions): Session persistence, resume, search, management, and per-platform session tracking
- [Profiles](https://docs.claway.io/user-guide/profiles)
- [Security](https://docs.claway.io/user-guide/security): Security model, dangerous command approval, user authorization, container isolation, and production deployment best practices
- [Checkpoints & Rollback](https://docs.claway.io/user-guide/checkpoints-and-rollback): Filesystem safety nets for destructive operations using shadow git repos and automatic snapshots

## Core Features

- [Features Overview](https://docs.claway.io/user-guide/features/overview)
- [Tools](https://docs.claway.io/user-guide/features/tools): Overview of Claway Agent's tools — what's available, how toolsets work, and terminal backends
- [Skills System](https://docs.claway.io/user-guide/features/skills): On-demand knowledge documents — progressive disclosure, agent-managed skills, and the Skills Hub
- [Curator](https://docs.claway.io/user-guide/features/curator): Background maintenance for agent-created skills — usage tracking, staleness, archival, and LLM-driven review
- [Memory](https://docs.claway.io/user-guide/features/memory): How Claway Agent remembers across sessions — MEMORY.md, USER.md, and session search
- [Memory Providers](https://docs.claway.io/user-guide/features/memory-providers): External memory provider plugins — Honcho, OpenViking, Mem0, Hindsight, Holographic, RetainDB, ByteRover, Supermemory
- [Context Files](https://docs.claway.io/user-guide/features/context-files): Project context files — .claway.md, AGENTS.md, CLAUDE.md, global SOUL.md, and .cursorrules — automatically injected into every conversation
- [Personality & SOUL.md](https://docs.claway.io/user-guide/features/personality): Customize Claway Agent's personality with a global SOUL.md, built-in personalities, and custom persona definitions
- [Plugins](https://docs.claway.io/user-guide/features/plugins): Extend Claway with custom tools, hooks, and integrations via the plugin system

## Automation

- [Cron Jobs](https://docs.claway.io/user-guide/features/cron): Schedule automated tasks with natural language, manage them with one cron tool, and attach one or more skills
- [Delegation](https://docs.claway.io/user-guide/features/delegation): Spawn isolated child agents for parallel workstreams with delegate_task
- [Kanban Multi-Agent](https://docs.claway.io/user-guide/features/kanban): Durable SQLite-backed task board for coordinating multiple Claway profiles
- [Persistent Goals](https://docs.claway.io/user-guide/features/goals): Set a standing goal and let Claway keep working across turns until it's done. Our take on the Ralph loop.
- [Code Execution](https://docs.claway.io/user-guide/features/code-execution): Programmatic Python execution with RPC tool access — collapse multi-step workflows into a single turn
- [Hooks](https://docs.claway.io/user-guide/features/hooks): Run custom code at key lifecycle points — log activity, send alerts, post to webhooks

## Media & Web

- [Voice Mode](https://docs.claway.io/user-guide/features/voice-mode): Real-time voice conversations with Claway Agent — CLI, Telegram, Discord (DMs, text channels, and voice channels)
- [Browser](https://docs.claway.io/user-guide/features/browser)
- [Vision](https://docs.claway.io/user-guide/features/vision)
- [Image Generation](https://docs.claway.io/user-guide/features/image-generation)
- [Text-to-Speech](https://docs.claway.io/user-guide/features/tts): Text-to-speech and voice message transcription across all platforms

## Messaging Platforms

- [Overview](https://docs.claway.io/user-guide/messaging): Chat with Claway from Telegram, Discord, Slack, WhatsApp, Signal, SMS, Email, Home Assistant, Mattermost, Matrix, DingTalk, Yuanbao, Microsoft Teams, LINE, Raft, Webhooks, or any OpenAI-compatible frontend via the API server — architecture and setup overview
- [WhatsApp](https://docs.claway.io/user-guide/messaging/whatsapp): Set up Claway Agent as a WhatsApp bot via the built-in Baileys bridge
- [Telegram](https://docs.claway.io/user-guide/messaging/telegram): Set up Claway Agent as a Telegram bot
- [Discord](https://docs.claway.io/user-guide/messaging/discord): Set up Claway Agent as a Discord bot
- [Slack](https://docs.claway.io/user-guide/messaging/slack): Set up Claway Agent as a Slack bot using Socket Mode
- [Signal](https://docs.claway.io/user-guide/messaging/signal): Set up Claway Agent as a Signal messenger bot via signal-cli daemon
- [Email](https://docs.claway.io/user-guide/messaging/email): Set up Claway Agent as an email assistant via IMAP/SMTP
- [Microsoft Teams](https://docs.claway.io/user-guide/messaging/teams): Set up Claway Agent as a Microsoft Teams bot

## Models & integrations

- [Integrations Overview](https://docs.claway.io/integrations)
- [Providers](https://docs.claway.io/integrations/providers)
- [MCP (Model Context Protocol)](https://docs.claway.io/user-guide/features/mcp): Connect Claway Agent to external tool servers via MCP — and control exactly which MCP tools Claway loads
- [Fallback Providers](https://docs.claway.io/user-guide/features/fallback-providers)

## Guides & Tutorials

- [Tips & Best Practices](https://docs.claway.io/guides/tips): Practical advice to get the most out of Claway Agent — prompt tips, CLI shortcuts, context files, memory, cost optimization, and security
- [Daily Briefing Bot](https://docs.claway.io/guides/daily-briefing-bot): Build an automated daily briefing bot that researches topics, summarizes findings, and delivers them to Telegram or Discord every morning
- [Use MCP with Claway](https://docs.claway.io/guides/use-mcp-with-claway): A practical guide to connecting MCP servers to Claway Agent, filtering their tools, and using them safely in real workflows
- [Use SOUL.md with Claway](https://docs.claway.io/guides/use-soul-with-claway): How to use SOUL.md to shape Claway Agent's default voice, what belongs there, and how it differs from AGENTS.md and /personality
- [Automate with Cron](https://docs.claway.io/guides/automate-with-cron): Real-world automation patterns using Claway cron — monitoring, reports, pipelines, and multi-skill workflows
- [Work with Skills](https://docs.claway.io/guides/work-with-skills): Find, install, use, and create skills — on-demand knowledge that teaches Claway new workflows
- [Webhook: GitHub PR Review](https://docs.claway.io/guides/webhook-github-pr-review): Connect Claway to GitHub so it automatically fetches PR diffs, reviews code changes, and posts comments — triggered by webhooks with no manual prompting

## Reference

- [CLI Commands](https://docs.claway.io/reference/cli-commands): Authoritative reference for Claway terminal commands and command families
- [Slash Commands](https://docs.claway.io/reference/slash-commands): Complete reference for interactive CLI and messaging slash commands
- [Environment Variables](https://docs.claway.io/reference/environment-variables): Complete reference of all environment variables used by Claway Agent
- [Tools Reference](https://docs.claway.io/reference/tools-reference): Authoritative reference for Claway built-in tools, grouped by toolset
- [Toolsets Reference](https://docs.claway.io/reference/toolsets-reference): Reference for Claway core, composite, platform, and dynamic toolsets
- [Bundled Skills Catalog](https://docs.claway.io/reference/skills-catalog): Catalog of bundled skills that ship with Claway Agent
- [Optional Skills Catalog](https://docs.claway.io/reference/optional-skills-catalog): Official optional skills shipped with claway — install via claway skills install official/<category>/<skill>
- [FAQ & Troubleshooting](https://docs.claway.io/reference/faq): Frequently asked questions and solutions to common issues with Claway