GitHub - eisbaw/ost: Open Source Teams 🧀

OST client := Open Source Teams client

A command-line client for Microsoft Teams written in Rust.

Ost means cheese in Danish.

Features

• TUI: Interactive terminal interface with teams, channels, chats, and per-user message colors
• Authentication: OAuth2 device code flow for work/school and personal accounts
• Messaging: List chats, read messages, send messages (stable)
• Teams: List joined teams and channels (stable)
• Real-time: WebSocket connection for push notifications (Trouter)
• Calling: Audio and video calls with RTP/SRTP media
• Audio (optional): Microphone capture and speaker playback (working)
• Video (optional): Camera capture via V4L2 and SDL2 display (WIP)

Status

Note: Video support is work-in-progress. Building with --features video-capture may interfere with audio functionality. For reliable audio calls, use --features audio only.

Requirements

• Rust 1.70+ (some dependencies are pinned for compatibility with older rustc versions)
• Linux (for audio/video features)
• Nix (recommended) or manual dependency installation
• just command runner (optional, for convenience recipes)

Dependencies

• Audio: ALSA development libraries
• Video: V4L2, SDL2, OpenH264

Installation

Using Nix (recommended)

The shell.nix provides all required dependencies. The just command runner executes recipes from the Justfile.

Manual

Install dependencies, then:

For audio support:

cargo build --features audio

For video support:

cargo build --features video-capture

For full A/V support:

cargo build --features "audio,video-capture"

Usage

TUI (Terminal User Interface)

Launch the interactive TUI for browsing teams, channels, and chats:

Authentication

Login with device code flow:

Force re-authentication (ignores cached token):

Check authentication status:

teams-cli status
teams-cli whoami

Messaging

List recent chats:

Read messages from a chat:

teams-cli read <chat-id> --limit 20

Send a message:

teams-cli send --to <chat-id> "Hello from CLI!"

Teams

List joined teams and channels:

Real-time Notifications

Connect to Trouter for push notifications:

Calling

Test microphone (requires --features audio):

Test camera (requires --features video-capture):

Place a test call to Echo bot:

teams-cli call-test --echo --duration 20

CLI Reference

teams-cli [OPTIONS] <COMMAND>

Options:
  -v, --verbose  Enable debug logging

Commands:
  login      OAuth2 device code authentication
             --force    Force re-login even if cached token exists
  logout     Clear stored credentials
  status     Show token expiry status
  whoami     Verify authentication
  chats      List recent chats
             --limit N  Number of chats to show
  read       Read messages from a chat
             --limit N  Number of messages to show
  send       Send a message
             --to ID    Chat ID to send to
  teams      List joined teams and channels
  tui        Launch interactive terminal user interface
  presence   Get/set presence status
  trouter    Connect to push notification service
  call-test  Place a test call
             --echo       Call the Echo bot (call quality tester)
             --duration N Call duration in seconds (default: 30)
             --thread ID  1:1 chat thread ID to call
             --record     Enable call recording
             --camera     Enable camera capture (video-capture feature)
             --display    Enable video display window (video-capture feature)
             --tone       Use test tone instead of microphone
  mic-test   Test microphone (audio feature)
  cam-test   Test camera (video-capture feature)

Testing

Unit Tests

Run the test suite:

just test
# or
cargo test

End-to-End Tests

E2E tests require a valid login session. Run all e2e tests:

Individual e2e tests:

Quality Checks

just check    # Run fmt-check, lint, and compile tests
just lint     # Run clippy lints
just fmt      # Format code

Configuration

Tokens are stored in ~/.config/teams-cli/config.toml with restricted permissions (0600).

Documentation

• Architecture Diagrams - Visual diagrams of authentication, messaging, calling, and media flows
• Terminology Index - Glossary of protocols and terms (RTP, SRTP, ICE, SDP, etc.)
• GUIDs Reference - Known Microsoft GUIDs (OAuth client IDs, tenant IDs, SEI UUIDs, bot MRIs)

License

MIT License - see LICENSE file.

Disclaimer

This is an unofficial client. Use at your own risk. Not affiliated with Microsoft.

Related Projects

• purple-teams - Teams plugin for libpurple (Pidgin, Finch, etc.)