marchat

Lightweight real-time terminal chat with E2E encryption

TLDR

Start the chat server interactively

$ marchat-server --interactive

Start the server with the admin panel enabled

$ marchat-server --admin-panel

Connect to a server as a named user

$ marchat-client --server [ws://host:8080/ws] --username [name]

Connect as an admin

$ marchat-client --server [ws://host:8080/ws] --admin --admin-key [key]

Show server diagnostics

$ marchat-server --doctor

SYNOPSIS

marchat-server [options]marchat-client [options]

marchat is a self-hosted, terminal-based group chat application with real-time WebSocket messaging, optional end-to-end encryption, a plugin system, file sharing, admin panel, and code snippet support. The TUI client is built with Bubble Tea and data is stored in SQLite.The server is configured via flags or environment variables (`MARCHATPORT`, `MARCHATADMINKEY`, `MARCHATGLOBALE2EKEY`, etc.). End-to-end encryption uses X25519/ChaCha20-Poly1305. The plugin system supports community-built extensions for ANSI image sharing, text filters, and custom commands.

PARAMETERS

--interactive

Guided setup prompt for the server when environment variables are not set.

--admin-panel

Enable the in-terminal admin interface on the server.

--web-panel

Enable the web-based admin interface on the server.

--config-dir PATH

Override the default configuration directory.

--doctor

Display server diagnostics in text format.

--doctor-json

Display server diagnostics as JSON.

--username NAME

Set the client username when connecting.

--server URL

Server WebSocket address to connect to (e.g. `ws://localhost:8080/ws`).

--admin

Connect with admin privileges.

--admin-key KEY

Admin authentication key.

--skip-tls-verify

Skip TLS certificate verification (useful with self-signed certificates).

CAVEATS

Requires running your own server instance. End-to-end encryption is optional and must be explicitly enabled via `MARCHATGLOBALE2E_KEY`. Running either binary without arguments launches an interactive configuration prompt.

HISTORY

marchat was created by Cod-e-Codes and is written in Go.