Getting Started

Get your team set up with AgentSync in under a minute.

Quick Start

Install the CLI globally
Authenticate with GitHub
Start syncing in your project

That's it. Every team member runs the same commands in the same repo.

How It Works

When you run agentsync start, the CLI connects to a sync server and automatically updates your AI agent's context file in real-time.

AgentSync writes directly to the context file your agent already uses:

  • CLAUDE.md for Claude Code
  • .cursorrules for Cursor
  • .github/copilot-instructions.md for Copilot
  • .windsurfrules for Windsurf

A ## AgentSync: Team Activity section is appended to these files with live information about what other team members' agents are working on.

What Gets Added

AgentSync appends a section to your existing context file that looks like this:

---
## AgentSync: Team Activity (auto-updated)
**Current Activity:**
- alice editing `src/auth/login.ts:45-120` (2m ago)
- bob editing `src/payments/checkout.ts` (30s ago)
**Warnings:**
- WARNING: alice is editing src/auth/login.ts:45-120
*Last updated: 2025-01-17T10:30:00.000Z*

Your existing context file content is preserved. Only the AgentSync section is updated.

Team Setup

  1. 1
    Create an account at app.agentsync.sh and generate an API key.
  2. 2
    Share the room ID with your team. Everyone working on the same repo should use the same room.
  3. 3
    Each team member runs agentsync login and agentsync start in their local clone.
  4. 4
    Agents sync automatically. No additional configuration needed.

CLI Commands

agentsync loginAuthenticate via GitHub OAuth
agentsync startStart syncing in current directory
agentsync statusShow connected agents and locks
agentsync stopStop syncing
agentsync logoutClear stored credentials

Supported AI Assistants

AgentSync automatically detects and updates the context file for your AI assistant. No manual configuration needed.

Claude CodeCLAUDE.md
Cursor.cursorrules
GitHub Copilot.github/copilot-instructions.md
Windsurf.windsurfrules

If the context file exists, AgentSync appends to it. For Claude Code, it will create CLAUDE.md if it doesn't exist.

Troubleshooting

Connection issues

Ensure you're authenticated with agentsync login. Check your network allows WebSocket connections to sync.agentsync.sh.

Context file not updating

Make sure agentsync start is running. Check the terminal output for errors.

Agents not seeing each other

All team members must be in the same room. The room is determined by the repository. Ensure everyone is in the same git repository.

Need help? Email [email protected]