# itwillsync

> Sync any terminal agent to your phone

Local network or Tailscale. Open source, agent-agnostic, zero cloud.

## Table of Contents

### Getting Started

- [Introduction](/itwillsync/docs/getting-started/introduction.md): Learn how itwillsync syncs terminal-based coding agents like Claude Code and Aider to your phone over local WiFi or Tailscale.
- [Installation](/itwillsync/docs/getting-started/installation.md): Install itwillsync via npx or npm. Requires Node.js 20+. Works on macOS, Linux, and Windows.
- [Quick Start](/itwillsync/docs/getting-started/quick-start.md): Get itwillsync running in 30 seconds. One command, scan QR code, control your coding agent from your phone.
- [Tailscale Setup](/itwillsync/docs/getting-started/tailscale.md): Set up itwillsync with Tailscale to control your coding agents from anywhere, not just your local WiFi network.
- [FAQ](/itwillsync/docs/getting-started/faq.md): Frequently asked questions about itwillsync — compatibility, security, troubleshooting, and supported coding agents.

### Dashboard

- [Dashboard Overview](/itwillsync/docs/dashboard/overview.md): Multi-session dashboard overview. Monitor all your running coding agents from one mobile-friendly interface.
- [Managing Sessions](/itwillsync/docs/dashboard/managing-sessions.md): Manage multiple coding agent sessions from the itwillsync dashboard. Start, stop, and switch between agents.
- [Live Previews](/itwillsync/docs/dashboard/live-previews.md): See real-time terminal output from all your coding agents in the dashboard without opening each session.
- [Security Model](/itwillsync/docs/dashboard/security.md): itwillsync security model: 256-bit tokens, rate limiting, constant-time comparison, zero cloud data storage.

### CLI Reference

- [Commands & Flags](/itwillsync/docs/cli/commands.md): itwillsync CLI reference: all commands, flags, and options for syncing terminal agents to your phone.
- [Hub Management](/itwillsync/docs/cli/hub.md): Hub daemon management: how itwillsync manages multiple agent sessions through a background process.
- [Configuration](/itwillsync/docs/cli/configuration.md): Configure itwillsync: network mode, ports, Tailscale, and persistent settings in ~/.itwillsync/config.json.

### Architecture

- [How It Works](/itwillsync/docs/architecture/overview.md): How itwillsync works internally: PTY wrapping, WebSocket protocol, HTTP server, and the hub daemon architecture.
- [WebSocket Protocol](/itwillsync/docs/architecture/protocol.md): itwillsync WebSocket protocol specification: message types, authentication flow, and terminal data encoding.
- [Hub Daemon](/itwillsync/docs/architecture/hub.md): Hub daemon architecture: session registration, port allocation, auto-shutdown, and multi-session coordination.
- [Contributing](/itwillsync/docs/architecture/contributing.md): Contributing to itwillsync: development setup, monorepo structure, PR guidelines, and coding conventions.