Back to docs
User guide
Overview · Quick start

Get started with Termchat

A concise tour of Termchat pulled from the latest user guide. See the new features, get installed in one line, and know what to expect on first launch before diving into deeper guides.

Install TermchatLearn the workflow

Key features from the guide

Secure authentication

Password-protected accounts with encrypted sessions and saved logins.

Friends system

Add friends, review incoming/outgoing requests, and see online status at a glance.

Real-time chat

Instant messaging with WebSockets, private DMs, and ephemeral rooms that self-destruct when empty.

File sharing

Upload with an interactive picker or a direct path, then download from the room feed.

Auto-update support

Built-in update notifications and one-command upgrades with `termchat --update`.

Built-in help

Keyboard shortcuts and commands available via `termchat --help` whenever you need them.

Quick start summary

Install, launch, and start chatting in under a minute.

curl -fsSL https://raw.githubusercontent.com/AlNaheyan/termchat/main/install.sh | sh
termchat                  # open the auth menu
# Add friend → press A
# Accept request → press I, Enter
# Start chat → pick friend, press Enter
# Upload → /upload (file picker)
# Download → /download filename.pdf

Need manual steps or PATH help? Jump to the installation guide for macOS, Linux, and Windows options.

What you see on first launch

The authentication menu mirrors the guide instructions.

Options
  • Log in with an existing account.
  • Sign up to create a new account (usernames are 4+ characters, letters/numbers only).
  • Quit to exit.
Session behavior
  • Sessions save locally so you stay logged in after closing the app.
  • Logout anytime from the Friends screen with L.

Update notifications and one-command upgrades

Auto-checks on launch

Starting with v1.3.0, Termchat checks for updates when you open the app. If a new release exists, you'll see:

🚀 Update available! v1.3.0 → v1.3.1 - Run: termchat --update
  • Non-blocking: chat starts immediately.
  • Silent if offline: no error appears when you're disconnected.
  • Opt-in: you choose when to update.
Upgrade in one command
termchat --update

The built-in updater downloads the correct binary for your platform, replaces the existing install, and verifies the result. If you're on an older build, re-run the install script instead.

Permission error while updating? Run with sudo if Termchat lives in /usr/local/bin.

Where to go next

Installation

Platform-specific commands and PATH setup.

Open installation
Using Termchat

Authentication rules, friends, chat commands, and shortcuts.

Open usage guide
Files & privacy

Upload/download flow, limits, and data handling.

Open files guide