Skip to content

README.md

Latest commit

 

History

History
74 lines (63 loc) · 3.46 KB

README.md

File metadata and controls

74 lines (63 loc) · 3.46 KB
title HybridClaw Docs
description User, operator, and developer documentation for HybridClaw installation, channels, workflows, extensibility, and runtime internals.
sidebar_position 1

HybridClaw Docs

This section turns the repo-shipped markdown docs into a browsable manual for operators, contributors, and advanced users. The structure follows audience and job-to-be-done, not repository internals:

  • Getting Started for first install, onboarding, and first run
  • Channels for the canonical transport manual across Discord, Slack, Telegram, email, WhatsApp, iMessage, and Microsoft Teams
  • Guides for operational and task-focused walkthroughs
  • Extensibility for tools, skills, plugins, and extension architecture
  • Developer Guide for architecture and maintainer-facing internals
  • Reference for commands, configuration, diagnostics, and tool reference

In the browser docs shell, each page can open its raw .md source directly or copy the full page markdown from the document header.

If you want a raw-markdown entrypoint that links every docs page directly, use For Agents.

Latest Highlights

  • Provider auth and model selection span HybridAI, Codex, OpenRouter, Mistral, Hugging Face, Gemini, DeepSeek, xAI, Z.AI, Kimi, MiniMax, DashScope, Xiaomi, Kilo Code, and local backends. Several remote providers also discover model catalogs at runtime.
  • Skills can be enabled or disabled globally or per channel from hybridclaw skill enable|disable, TUI /skill config, or the admin Skills page.
  • Built-in memory can stay standalone or layer with ByteRover, Mem0, Honcho, MemPalace, QMD, and GBrain plugins. The Memory Plugins guide compares the main tradeoffs.
  • HybridClaw can emit OpenTelemetry traces to OTLP backends when OTEL_ENABLED=true or OTEL_EXPORTER_OTLP_ENDPOINT is set, correlating gateway and agent spans with structured logs.

Browse By Section

  • Getting Started for installation, onboarding, provider authentication, and connecting the first transport
  • Channels for the full supported channel catalog and transport-specific setup details
  • Guides for local providers, MCP, bundled skills, remote access, voice/TTS, and optional office tooling
  • Extensibility for tools, skills, plugins, agent packages, and extension-specific operator workflows
  • Developer Guide for architecture, runtime behavior, session routing, testing, and release mechanics
  • Reference for model selection, configuration, diagnostics, commands, and FAQ

Fast Paths

  • Need to install HybridClaw quickly? Go to Installation.
  • Need the shortest path to a running gateway and chat UI? Go to Quick Start.
  • Need to connect one transport without reading the full channel manual? Go to Connect Your First Channel.
  • Need command lookup or troubleshooting help? Go to Commands and Diagnostics.
  • Need setup answers before deploying? Go to FAQ.
  • Need to reach /chat, /agents, or /admin from another machine? Go to Remote Access.
  • Need one markdown page that links the whole docs tree? Go to For Agents.