> ## Documentation Index
> Fetch the complete documentation index at: https://sincronizado.micr.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick start

> Get up and running in minutes.

Follow these steps to get a supercharged local-remote workflow.

## 1. Install & Setup

Run the installer. It will set up the binary, then run `sinc --setup` to configure your VPS, SSH keys, and sync.

**Mac / Linux:**

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -fsSL https://sync.micr.dev/install.sh | bash
```

**Windows (PowerShell):**

```powershell theme={"theme":{"light":"github-light","dark":"github-dark"}}
irm https://sync.micr.dev/install.ps1 | iex
```

Then run:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
sinc --setup
```

## 2. Connect

Navigate to any project on your machine and run `sinc`.

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
cd ~/my-projects/awesome-app
sinc
```

**What just happened?**

* Created `~/workspace/awesome-app` on your VPS.
* Synced your files instantly.
* Connected via SSH.
* Started an AI agent in a persistent tmux session.

## 3. Workflow

* **Edit code locally**: use your favorite editor or tool on your own files.
* **Run commands remotely**: `sinc` drops you into a remote shell where your agent is running.
* **Detach**: press `Ctrl+B`, then `D`. The session stays alive.
* **Resume**: type `sinc -r` later to pick up exactly where you left off.

## Commands Cheat Sheet

| Command            | Action                                             |
| :----------------- | :------------------------------------------------- |
| `sinc`             | Connect (or create) session for current folder     |
| `sinc -r`          | Resume existing session                            |
| `sinc push`        | Force local -> remote sync (asks for confirmation) |
| `sinc pull`        | Force remote -> local sync (asks for confirmation) |
| `sinc --list`      | Show all active sessions                           |
| `sinc -l`          | Short alias for list                               |
| `sinc --kill <id>` | Stop sync and kill remote session                  |
| `sinc -k <id>`     | Short alias for kill                               |
| `sinc kill <id>`   | Subcommand alias for kill                          |
| `sinc --setup`     | Re-run configuration wizard                        |

## Next Steps

* [Installation Guide](/installation) - Detailed install & dependencies.
* [VPS Setup](/vps-setup) - How to prepare your server.
* [Configuration](/configuration) - Customize ignores, paths, and agents.
* [Architecture](/architecture) - How it works under the hood.