Linux command
marchat 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
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
说明
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 (`MARCHAT_PORT`, `MARCHAT_ADMIN_KEY`, `MARCHAT_GLOBAL_E2E_KEY`, 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.
参数
- --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).
FAQ
What is the marchat command used for?
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 (`MARCHAT_PORT`, `MARCHAT_ADMIN_KEY`, `MARCHAT_GLOBAL_E2E_KEY`, 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.
How do I run a basic marchat example?
Run `marchat-server --interactive` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does --interactive do in marchat?
Guided setup prompt for the server when environment variables are not set.