Skip to content
AgentSync

Getting started

agentsync is a fast, portable CLI tool for synchronizing AI agent configurations across multiple coding assistants using symbolic links.

Installation

Section titled “Installation”
Section titled “From GitHub Releases (Recommended)”

Download the latest release for your platform:

macOS (Apple Silicon)

Section titled “macOS (Apple Silicon)”
Terminal window
curl -LO https://github.com/dallay/agentsync/releases/latest/download/agentsync-aarch64-apple-darwin.tar.gz
tar xzf agentsync-aarch64-apple-darwin.tar.gz
sudo mv agentsync-*/agentsync /usr/local/bin/

Linux (x86_64)

Section titled “Linux (x86_64)”
Terminal window
curl -LO https://github.com/dallay/agentsync/releases/latest/download/agentsync-x86_64-unknown-linux-gnu.tar.gz
tar xzf agentsync-x86_64-unknown-linux-gnu.tar.gz
sudo mv agentsync-*/agentsync /usr/local/bin/

From Source (Requires Rust 1.85+)

Section titled “From Source (Requires Rust 1.85+)”

If you have Rust installed, you can install directly from crates.io or from the repository:

Terminal window
# From crates.io
cargo install agentsync


# From GitHub
cargo install --git https://github.com/dallay/agentsync

Basic Usage

Section titled “Basic Usage”

1. Initialize Configuration

Section titled “1. Initialize Configuration”

Run init in your project root to create the default structure:

Terminal window
agentsync init

This creates a .agents/ directory with an initial agentsync.toml and an AGENTS.md file.

2. Configure your Agents

Section titled “2. Configure your Agents”

Edit .agents/agentsync.toml to define which assistants you use. By default, it includes configurations for Claude Code and GitHub Copilot.

[agents.claude]
enabled = true
# ... configuration ...
Section titled “3. Apply Symlinks”

Create the symbolic links in your project root:

Terminal window
agentsync apply

This will create files like CLAUDE.md and .github/copilot-instructions.md that point back to your single source of truth in .agents/.

4. Integration with pnpm/npm

Section titled “4. Integration with pnpm/npm”

We recommend adding the apply command to your prepare script to ensure symlinks are always present for your team:

{
  "scripts": {
    "prepare": "agentsync apply || true"
  }
}

Note: || true ensures the install process does not fail if agentsync is not yet installed, such as on a fresh clone or in CI environments.

Next Steps

Section titled “Next Steps”