README.md

TypeFerry Documentation

Use this page to choose the smallest guide that matches what you are building. PROTOCOL.md is the normative source for wire behavior; these guides explain application development against the current implementations.

Note

The TypeScript package is published on npm as typeferry; Python, Rust, and Ruby publication remains disabled. Begin with the quickstart and consult RELEASING.md for operator guidance.

Start here

• Run the full TypeScript application template
• Build an application with an AI coding agent
• Understand the protocol
• Compare implementation architecture

TypeScript

Goal	Guide
Understand the package and local setup	typeferry-ts/README.md
Develop, build, test, configure, or migrate an application	Application framework
Create a server and RPC methods	Server and RPC
Use the browser or Node client	Client
Bind TypeFerry to React	React
Add authentication and sessions	Authentication
Publish and consume events	Events and channels
Use typed MongoDB collections and live invalidation	MongoDB
Serialize extended values	EJSON
Query and observe in-memory application data	Local document collections
Build and deploy a Node.js application	Deployment

Python

The Python implementation is a server library with EJSON, protocol messages, methods, decorators, HTTP/WebSocket/Redis transports, auth, and conformance support. It does not provide a browser client.

• Python server development
• Python runtime architecture

Rust

The Rust implementation is a modular server workspace with optional HTTP, WebSocket, Redis, auth, and macro features. It does not provide a browser client.

• Rust server development
• Rust runtime architecture

Ruby

The Ruby implementation is a Rack/Puma server library with EJSON, HTTP and WebSocket RPC, Redis events, authentication, RBS types, and conformance support. It does not provide a browser client and is consumed directly from a pinned Git revision while RubyGems publication remains disabled.

• Ruby server development
• Ruby runtime architecture

Protocol and conformance

• Wire protocol
• Shared conformance fixtures
• Protocol change runbook
• Conformance failure diagnosis

Contributor and maintainer documentation

• Agent/contributor task router
• Architecture overview
• Release verification
• Dependency updates
• Current release status

Documents under plans/ are historical and non-normative. Accepted decisions live under decisions/, and task specifications live under specs/.

AI tools may use the repository-root llms.txt as a compact navigation index. It does not replace the linked documentation or define crawler access policy.