Documentation

Guides, references, and deep dives. Pick your track.

Start here

What is freeq?What this is, how it differs from IRC and Slack/Discord, and why it matters
Getting startedConnect as a user, run your own server, build your first bot
Connection guideEvery supported transport and client
Different from IRC how?DID identity, persistent ops, modern features — for IRC veterans

For agents the good stuff

Identity, observable work, governance, and voice for AI agents — as protocol, not framework.

Agent quickstart newA did:key agent saying hello in #playground, in about 60 seconds
Watch your coding agent newWire Claude Code / pi into a channel you can read from irssi on your phone
Building agentsThe five primitives — identity, events, governance, provenance, liveness — plus a full worked tutorial
Bot quickstartYour first bot in 10 minutes, TypeScript or Rust
TypeScript SDK@freeq/sdk + @freeq/bot-kit reference
Voice & video agentsJoin live calls: media loop, voice-activity segmentation, talking back
Bot frameworkCommands, permissions, webhooks, LLM personas
Agent assistanceStructured diagnostics at /agent/tools/* — let your bot ask the server why
Agent discoveryA2A-style discovery at /.well-known/agent.json

For humans

Clients overviewAll six first-party clients + guest access from any IRC client
Web clientReactions, threads, media, search, calls — in a tab
iOS appNative SwiftUI via Rust FFI
AuthenticationAT Protocol SASL, OAuth, web tokens, DID identity

Protocol

Everything is an IRCv3 extension. These are the specs.

Protocol overviewThe whole surface on one page
Tag registry newEvery +freeq.at/* message tag with semantics
Protocol notes deepSASL ATPROTO-CHALLENGE, DID extensions, transport stack, plugin hooks
AV call protocolTAGMSG signaling + MoQ media transport
FederationS2S over iroh QUIC with CRDT convergence
Policy frameworkChannel governance as verifiable credentials + transparency logs
Credential verifiersGitHub verifier, custom verifiers, decoupled architecture
REST APIHealth, channels, history, users, upload, policy, credentials
AV QUIC migration deepThe move to QUIC/WebTransport — SFU, MoQ, deploys

Run a server

Self-hosting guideTLS, nginx, systemd, credential verifiers
Self-hosting end to endSingle host from scratch: build, secrets, DID, proxy, backups
freeq for teams newPrivate company chat: self-host + SSO-gated E2EE channels
ModerationHalfops, moderator credentials, third-party moderation services
Policy system guideChannel policies, credential types, web UI, DID ops
Policy demoInteractive policy walkthrough

Trust & security

The honest pages. Read these before you trust us with anything.

Encryption & securityEvery data path mapped — what's encrypted, what's not, and the roadmap
Company E2EE channelsPrivate, SSO-gated, end-to-end encrypted channels — offboarding revokes access
VC-bootstrapped E2EE deepEG1/EGK1 wire formats, sealed group keys, epoch rotation
S2S federation audit deepServer-to-server correctness analysis
Known limitationsExplicit gaps, in public, on purpose

Background

Feature catalog deepEvery implemented feature with status
Architecture decisions deepDesign rationale and tradeoffs
Future directionPlanned features and long-term vision

Source

All documentation lives in the GitHub repository. Site docs are in freeq-site/docs/, technical docs in docs/.

Supported by
Powered by