Documentation

Everything you need to know about using SquadX Live for collaborative screen sharing.

Getting Started

SquadX Live makes it easy to share your screen and collaborate in real-time. Here's how to get started:

  1. Download the desktop app - Visit the download page and install SquadX Live on your computer.
  2. Start a session - Open SquadX Live and click "Start Session" to begin sharing.
  3. Share the link - Copy the join link and send it to your collaborator.
  4. Collaborate - Your viewer can now see your screen and request control.

System Requirements

macOS

  • macOS 12 (Monterey) or later
  • Apple Silicon or Intel
  • Screen Recording permission
  • Accessibility permission (for control)

Windows

  • Windows 10 (1809) or later
  • x64 or ARM64
  • No special permissions needed

Linux

  • X11 (recommended) or Wayland
  • x64 architecture
  • PipeWire for screen capture

Viewer Requirements

Viewers only need a modern web browser. We recommend:

  • Chrome 90+
  • Firefox 90+
  • Safari 15+
  • Edge 90+

Hosting a Session

To host a screen sharing session:

1. Choose what to share

Select your entire screen or a specific application window. The screen picker shows previews of all available sources.

Once you start a session, you'll see your screen being shared with a green border indicator. The session toolbar shows the join link and current viewers.

Viewing a Session

To join a screen sharing session, simply open the join link in your browser. No account or installation is required.

The viewer shows the host's screen in real-time. You can use the toolbar to:

  • Toggle fullscreen mode
  • Request remote control
  • See connection quality
  • Leave the session

Remote Control

Control requires host approval

Viewers must request control, and hosts must explicitly approve. Control can be revoked at any time.

How control works

  1. Viewer requests control - Click the control button in the viewer toolbar.
  2. Host approves - The host sees a notification and can approve or deny.
  3. Control is granted - The viewer can now use mouse and keyboard.
  4. Simultaneous control - Both host and viewer can control at the same time.

Emergency revoke

Press Ctrl+Shift+Escape at any time to instantly revoke all remote control. This hotkey cannot be overridden.

Security

End-to-End Encryption

All media is encrypted using WebRTC DTLS-SRTP. Your screen content never passes through our servers.

Peer-to-Peer

Connections are established directly between host and viewer using WebRTC.

SquadX Live is designed with security as a core principle. Key security features include:

  • Explicit consent required for all control
  • Visual indicators when sharing/control is active
  • Emergency revoke hotkey
  • No permanent storage of screen content or input events
  • Open source for full auditability

Troubleshooting

Connection issues?

Most connection problems are caused by firewalls or corporate networks. Try using a different network or enabling TURN relay.

Common issues

Screen Recording permission denied (macOS)

Go to System Preferences → Security & Privacy → Privacy → Screen Recording and enable SquadX Live.

Viewer cannot connect

  • Ensure both parties have a stable internet connection
  • Try disabling VPN if active
  • Check that WebRTC is not blocked by browser extensions

Poor video quality

  • Check your internet upload speed (5+ Mbps recommended)
  • Close bandwidth-heavy applications
  • Try lowering the quality setting in preferences

Uninstalling

Linux

Run the built-in uninstall command to remove everything:

squadx-live uninstall

This removes the AppImage, launcher script, desktop entry, and icon.

To uninstall manually:

rm -rf ~/.squadx-live
rm -f ~/.local/bin/squadx-live
rm -f ~/.local/share/applications/squadx-live.desktop
rm -f ~/.local/share/icons/hicolor/256x256/apps/squadx-live.png

macOS

Drag SquadX Live.app from your Applications folder to the Trash. To also remove the CLI launcher:

rm -f ~/.local/bin/squadx-live

Windows

Open Settings → Apps → Installed apps, find SquadX Live, and click Uninstall. Alternatively, run the uninstaller from the Start Menu.

Frequently Asked Questions

Is SquadX Live free?

Yes, SquadX Live is completely free and open source under the MIT license. There are no premium tiers or paid features.

Do viewers need to install anything?

No, viewers can join from any modern browser. The web viewer is a Progressive Web App (PWA) that doesn't require installation, though viewers can optionally install it for quick access.

Is my screen content encrypted?

Yes. All media streams are encrypted using WebRTC DTLS-SRTP encryption. The connection is peer-to-peer, meaning your screen data never passes through our servers.

Can I self-host SquadX Live?

Yes. Since SquadX Live uses WebRTC, the screen sharing happens peer-to-peer. You only need to run your own TURN server for NAT traversal. The signaling can use Supabase's free tier or your own instance.

What happens if I lose connection?

SquadX Live automatically attempts to reconnect. During brief disconnections, viewers will see a reconnecting indicator. For longer outages, viewers may need to rejoin using the same link.

Can multiple viewers join a session?

Currently, SquadX Live supports one viewer per session. Multi-viewer support is planned for a future release.

Does the viewer see my cursor?

Yes, your cursor is captured as part of the screen share. When the viewer is granted control, you'll also see their remote cursor as an overlay.

Can I share audio?

Audio sharing is on our roadmap but not yet implemented. Currently, SquadX Live is focused on visual screen sharing and control.

How do I uninstall SquadX Live?

Run "squadx-live uninstall" to completely remove SquadX Live, including the desktop app, launcher script, desktop entry, and icon. On macOS, you can also drag SquadX Live from Applications to the Trash.

Need more help?

If you can't find what you're looking for, check out our GitHub Discussions or open an issue.