DEVELOPER RESOURCES

From protocol to running implementations

Choose .NET SDK 1.6.0 or the TypeScript SDK alpha to add accounts, encrypted messaging, groups, and channels. Read the online guides, API reference, protocol specification, and test vectors.

Back to home
01Meshline Protocol 1.002Meshline .NET SDK03Meshline TypeScript SDK04Meshline Relay05Meshline CLI
01

Meshline Protocol 1.0

The specification defines interoperability between compatible clients, relays, and push gateways. It covers accounts and devices, encrypted messages, routing, channels, and groups, with test vectors for conformance validation.

  • Specification draft and security boundaries
  • Core services and optional hosting
  • Nine test-vector suites and behavioral requirements
Read the specificationProtocol on GitHub

The specification is available in Simplified Chinese and English. Chinese is authoritative; both versions share the same JSON test vectors.

02

Meshline .NET SDK

1.6.0 is on NuGet and requires .NET 10. Use MeshlineClient to manage accounts, devices, and contacts, and add encrypted private messages, groups, channels, and SQLite persistence to your app. The guides cover account setup, session recovery, push gateway configuration, and application integration examples.

  • Accounts, devices, and relay connections
  • Private messages, groups, and channels
  • SQLite persistence and sync recovery

Meshline.Sdk 1.6.0 · .NET 10

dotnet add package Meshline.Sdk --version 1.6.0

Select RpcRelayRegistry and Nep6AccountSigner or provide your own registry and signing adapters. Applications still supply ISecretProtector. The guide covers account establishment, session recovery, and resource ownership.

03

Meshline TypeScript SDK

0.1.0-alpha.6 is on npm with ESM packages and TypeScript declarations. The core SDK handles accounts, encrypted messages, groups, and channels; platform adapters connect storage and transport for Node.js, browsers, or Expo. Choose packages for your runtime and review its requirements and validation scope.

  • ESM packages and TypeScript declarations
  • Node.js, browser, and Expo adapters
  • Accounts, encrypted messaging, and persistence

@meshline/sdk 0.1.0-alpha.6 · Node.js

npm install @meshline/sdk@0.1.0-alpha.6 @meshline/storage-node@0.1.0-alpha.6 @meshline/transport-node@0.1.0-alpha.6

The command above installs the Node.js packages. See the quick start and platform guide for browser and Expo installation, native dependencies, and validation limits.

04

Meshline Relay

Meshline Relay provides compatible clients with message delivery and synchronization, channel and group hosting, and offline notifications to device-declared push gateways. Clients encrypt and decrypt private content; relays route and deliver ciphertext.

  • Message delivery and synchronization
  • Channel and group hosting
  • Offline push for private and group messages

Implemented; source code is not public

Offline push is best effort, contains no message content, and does not guarantee device delivery. End-to-end gateway and app integration, Android/iOS receipt, and notification navigation remain pending acceptance.

05

Meshline CLI

Command-line client 0.3.0 provides self-contained Windows and Linux x64 downloads for people, scripts, and AI agents. Each profile manages one account. Exchange encrypted messages, work with groups and channels, query local history, and stay synchronized through an interactive session or a background daemon.

  • Accounts, contacts, encrypted messages, and channels
  • JSON output and noninteractive credentials
  • Interactive sessions, background sync, and local history queries

The CLI is a development preview, separate from the unpublished WPF reference client. Linux daemon/systemd live acceptance and cross-relay acceptance remain pending; watch has no durable replay or exactly-once consumption guarantee.

MeshlineRegistry reference contract

The MeshlineRegistry reference contract is public on GitHub, with source code, build and test instructions, a complete ABI reference, and an operations guide covering deployment, upgrades, relay maintenance, and governance.

STATUS / 1.0

Current capability boundary

.NET SDK 1.6.0 is released; Meshline Protocol 1.0 remains a specification draft. Account keys can restore device authorization and home-relay routing; contacts, messages, and group secrets depend on existing devices, available material, or backups.

The .NET SDK has passed offline tests; live-relay interoperability and cross-platform release validation remain pending. The TypeScript SDK is alpha; consult its platform requirements and limits. Applications select signing and registry adapters, provide secret protection, and handle content and UI.

Reference implementation source

.NET and TypeScript SDKs, Meshline CLI, and Registry contracts are public