# Traxus **Repository Path**: stonego/Traxus ## Basic Information - **Project Name**: Traxus - **Description**: No description available - **Primary Language**: Unknown - **License**: AGPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-10-24 - **Last Updated**: 2026-10-28 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
# TRAXUS
*Real-time text and voice chat — entirely in your terminal.*



---
## Why Traxus?
| | Traxus | Discord / Slack |
|---|---|---|
| Runs in a terminal | ✓ | ✗ |
| Works over SSH | ✓ | ✗ |
| Self-hosted | ✓ | ✗ |
| Zero telemetry | ✓ | ✗ |
| Voice (WebRTC / Opus P2P) | ✓ | ✓ |
| Free forever | ✓ | Paywalled features |
| Open source | ✓ | ✗ |
---
## Features
### 💬 Text Chat
- Multiple channels — join, leave, create on the fly
- Scrolling message history with Rich-formatted output
- Per-channel member list (`/who`) with live presence updates
- Change your nick at any time (`/nick`)
### 🎙️ Voice
- **Peer-to-peer WebRTC audio** — voice goes directly between clients via
aiortc + Opus; the server only handles signalling (offer/answer/ICE).
No audio data ever touches the server.
- **Three PTT modes** via `/settings`:
- `Toggle` — press F9 once to start, again to stop
- `Hold` — hold F9 while speaking (hands-free release)
- `VAD` — voice activity detection; mic opens automatically when you speak
- Live mic indicator in the status bar (`● MIC`)
- Per-user volume control (0–200 %) from the member panel
- VAD calibration screen with live energy bar chart and adjustable threshold
- Rebind PTT to any key or mouse button (middle-click recommended)
- **Audio device selection** — choose input and output devices from `/settings`;
hot-swaps mid-call without requiring a rejoin, without freezing the UI
- Graceful degradation — all text features work without `sounddevice` or `aiortc`
### ⌨️ Terminal-native UX
- Keyboard-first — full slash command set, no mouse required
- Tab / Shift+Tab completes slash command names in the input bar
- Up / Down arrow recalls previously submitted slash commands
- Sidebar groups text and voice channels with live member counts
- Status bar: connection state, username, latency, PTT indicator
- Login (server URL + username) persists across restarts
### 🚀 Self-hostable in minutes
- Single asyncio WebSocket server, zero database, zero config files
- Deploy on any Ubuntu 24.04 VPS (Hetzner, OVH, Linode, …)
- TLS via Caddy + Let's Encrypt (any domain or free dynamic DNS subdomain)
- Optional password authentication — bcrypt-hashed credentials, enabled per-server
- Managed by systemd — see [deploy/deploy.md](deploy/deploy.md)
---
## Pre-built binaries
Self-contained executables for Windows and macOS are attached to every
[GitHub release](https://github.com/eal49/Traxus/releases). No Python install required.
### Windows — SmartScreen warning
The `.exe` is not code-signed, so Windows will show a "Windows protected your PC" prompt on first run.
1. Click **More info**
2. Click **Run anyway**
The app is safe to run — you can inspect the full source and the build workflow
([`.github/workflows/release.yml`](.github/workflows/release.yml)) yourself.
### macOS — Gatekeeper quarantine
macOS quarantines executables downloaded from the internet. Clear the flag before the first run:
```bash
xattr -rd com.apple.quarantine ./traxus-*-macos-arm64
chmod +x ./traxus-*-macos-arm64
./traxus-*-macos-arm64
```
> **Note:** The macOS binary targets Apple Silicon (arm64). Intel Macs are not supported by the binary — run from source instead.
---
## Quick Start
```bash
# Install dependencies
pip install textual websockets
# Voice (optional — enables PTT, VAD, and WebRTC audio)
pip install sounddevice numpy aiortc av
# Terminal 1 — start the server
python -m server.main
# Terminal 2, 3, … — connect clients
python -m client.main
```
On the login screen enter `ws://localhost:8765`, pick a username, and press **Connect**.
If the server requires a password, fill in the **Password** field before connecting.
> **Python 3.14+** is required.
---
## Slash Commands
| Command | What it does |
|---|---|
| `/join