Skip to main content

Distribute and sync dev tool configurations across teams

Project description

๐ŸŽฏ Config Sync

Distribute and sync coding standards, AI tool configurations, and MCP servers across your team

CI Coverage PyPI version Python 3.10+ License: MIT

Works with: Claude Code โ€ข Claude Desktop โ€ข Cline โ€ข Cursor โ€ข GitHub Copilot โ€ข Kiro โ€ข Roo Code โ€ข Windsurf


What is Config Sync?

Config Sync is a CLI tool for distributing and managing AI coding assistant configurations across teams:

  • ๐Ÿ“‹ Templates: Share coding standards, slash commands, and IDE configurations from Git repositories
  • ๐Ÿ”Œ MCP Servers: Distribute and manage Model Context Protocol server configurations
  • ๐Ÿ”„ Sync: Keep your team aligned with single-command updates
  • โœ… Safe: Built-in validation, automatic backups, conflict resolution

Note: Commands use aiconfig (short for Config Sync)


๐Ÿš€ Quick Start

Install

pip install configsync

Templates: Share Coding Standards (30 seconds)

# Navigate to where you want to create the template
cd ~/projects  # or your preferred location

# Create template repository (creates 'my-standards' directory here)
aiconfig template init my-standards

# Work inside it and install locally to test
cd my-standards
aiconfig template install . --as demo

# Your IDE now has coding standards in .claude/rules/demo.*

MCP: Configure AI Tool Servers (2 minutes)

# Install MCP server configurations from a repository
aiconfig mcp install https://github.com/company/mcp-servers --as backend

# Configure credentials securely (stored in gitignored .env)
aiconfig mcp configure backend

# Sync to AI tools (Claude Desktop, Cursor, Windsurf)
aiconfig mcp sync --tool all

Packages: Install Complete Development Setups (1 minute)

# Install a complete package with instructions, hooks, and commands
aiconfig package install ./example-package --ide claude

# List installed packages
aiconfig package list

# Your IDE now has everything: instructions, MCP servers, hooks, commands

Core Features

๐ŸŽจ Template System

Distribute any IDE-specific content from Git repositories:

  • Coding Standards โ†’ .claude/rules/ (instructions for AI)
  • Slash Commands โ†’ .claude/commands/ (accessible as /command-name)
  • IDE Hooks โ†’ Pre/post prompt automation
  • Any Configuration โ†’ Snippets, settings, etc.

Key Commands:

aiconfig template install <repo> --as <namespace>  # Install templates
aiconfig template list                             # Show installed templates
aiconfig template update <namespace>               # Update to latest version
aiconfig template uninstall <namespace>            # Remove templates

๐Ÿ“– Full Template Documentation โ†’

๐Ÿ”Œ MCP Server Management

Manage Model Context Protocol servers across your team:

  • Share Configurations โ†’ Distribute MCP server setups via Git
  • Secure Credentials โ†’ Store secrets in gitignored .env files
  • Multi-Tool Sync โ†’ One command syncs to Claude Code, Claude Desktop, Cursor, Windsurf
  • Environment Resolution โ†’ Automatically inject credentials at sync time

Supported IDEs:

IDE MCP Config Location Tool Limit
Claude Code .claude/settings.local.json Unlimited
Claude Desktop ~/Library/Application Support/Claude/claude_desktop_config.json Unlimited
Cursor .cursor/mcp.json or ~/.cursor/mcp.json 40 tools
Windsurf ~/.codeium/windsurf/mcp_config.json 100 tools
GitHub Copilot .vscode/mcp.json 128 tools

Key Commands:

aiconfig mcp install <repo> --as <namespace>       # Install MCP configs
aiconfig mcp configure <namespace>                 # Set up credentials
aiconfig mcp sync --tool all                       # Sync to AI tools
aiconfig mcp list                                  # Show installed servers

๐Ÿ“– Full MCP Documentation โ†’

๐Ÿ“ฆ Configuration Packages

Bundle and distribute complete AI assistant configurations:

  • Multi-Component Packages โ†’ Combine instructions, MCP servers, hooks, commands, skills, workflows
  • IDE-Aware Installation โ†’ Automatically adapts to target IDE capabilities
  • Package Creation โ†’ Generate packages from existing project configurations
  • Secret Detection โ†’ Automatically templates secrets in MCP configs
  • Conflict Resolution โ†’ Handle existing files with skip, overwrite, or rename strategies

Key Commands:

aiconfig package create --name my-pkg                # Create package from project
aiconfig package install <package-path> --ide <ide>  # Install package
aiconfig package list                                 # Show installed packages
aiconfig package uninstall <package-name>            # Remove package

๐Ÿ“– Full Package Documentation โ†’


Why Config Sync?

For Teams

โœ… Consistency - Everyone uses the same standards and tools โœ… Onboarding - New members get configured in minutes โœ… Compliance - Enforce security policies and code review checklists โœ… No Secrets in Git - Credentials stay local, configs are shared

For Individuals

โœ… Portable - Same setup across all your machines โœ… Composable - Mix company + team + personal configurations โœ… Discoverable - Install templates from any Git repository โœ… Safe - Automatic backups, conflict resolution, validation


Real-World Example

Here's how a team at ACME Corp uses Config Sync:

# 1. Everyone installs company security policies (global, applies to all projects)
aiconfig template install https://github.com/acme/security-policy --as acme-security --scope global

# 2. Backend team members clone their project
git clone https://github.com/acme/backend-api.git && cd backend-api

# 3. Install team-specific templates (project scope)
aiconfig template install https://github.com/acme/backend-standards --as backend
aiconfig template install https://github.com/acme/python-patterns --as python

# 4. Install and configure MCP servers (for enhanced AI capabilities)
aiconfig mcp install https://github.com/acme/mcp-servers --as backend-mcp
aiconfig mcp configure backend-mcp
aiconfig mcp sync --tool claude

# Done! IDE now has:
# - Global security rules (all projects)
# - Backend coding standards (this project)
# - Python patterns (this project)
# - MCP servers configured (Claude Desktop, Cursor, etc.)

Team members update everything with:

aiconfig template update --all
aiconfig mcp update --all

Documentation

Guide Description
Templates Comprehensive guide to the template system
MCP Servers Managing Model Context Protocol servers
Packages Complete package management guide (install, create, manage)
CLI Reference Complete command reference
Advanced Usage Scopes, namespaces, conflict resolution
Creating Templates How to build your own template repositories

Project vs Global Scope

Config Sync supports two installation scopes:

Scope Where Files Go When Active Best For
Project (default) <project>/.claude/rules/
<project>/.ai-config-kit/
Only in that project Team practices, project standards
Global ~/.claude/rules/
~/.ai-config-kit/
All projects Personal tools, company policies

Example:

# Global: Company-wide security policy (applies everywhere)
aiconfig template install https://github.com/company/security --as security --scope global

# Project: Team-specific patterns (only this project)
cd ~/projects/backend-api
aiconfig template install https://github.com/team/backend-patterns --as backend

Your IDE gets both: global templates (always available) + project templates (context-specific).


What Can You Distribute?

Templates

Any IDE-specific content from Git repositories:

  • Coding standards and style guides
  • Security checklists and compliance rules
  • Custom slash commands (accessible as /command-name)
  • Code review templates
  • Architecture decision records (ADRs)
  • Testing patterns and strategies
  • IDE automation hooks (pre-prompt, post-prompt)

Packages

Complete configuration bundles with multiple component types:

Component Claude Cline Cursor Kiro Roo Code Windsurf Copilot
Instructions .claude/rules/ .clinerules/ .cursor/rules/ .kiro/steering/ .roo/rules/ .windsurf/rules/ .github/instructions/
MCP Servers โœ… โŒ โœ… โŒ โœ… โœ… โœ…
Hooks โœ… โŒ โŒ โŒ โŒ โŒ โŒ
Commands โœ… โŒ โŒ โŒ โœ… โŒ โŒ
Skills โœ… โŒ โŒ โŒ โŒ โŒ โŒ
Workflows โŒ โŒ โŒ โŒ โŒ โœ… โŒ
Memory Files โœ… (CLAUDE.md) โŒ โŒ โŒ โŒ โŒ โŒ
Resources โœ… โœ… โœ… โœ… โœ… โœ… โŒ

MCP Server Configurations

Model Context Protocol server setups for enhanced AI capabilities:

  • Database access (PostgreSQL, MySQL, SQLite)
  • API integrations (GitHub, Jira, Slack)
  • File system access with proper permissions
  • Custom tools and commands
  • Development environment connections

Installation & Setup

Requirements

  • Python 3.10 or higher
  • Git (for cloning template repositories)
  • One of: Claude Code, Claude Desktop, Cline, Cursor, GitHub Copilot, Kiro, Roo Code, or Windsurf

Install Config Sync

# Using pip
pip install configsync

# Verify installation
aiconfig --version

Quick Configuration

# Check which AI tools are installed
aiconfig tools

# Navigate to where you want to create templates
cd ~/projects  # or your preferred location

# Create template repository (creates 'my-standards' directory here)
aiconfig template init my-standards

# Work inside it and install to test
cd my-standards
aiconfig template install . --as demo

# View installed templates
aiconfig template list

Common Use Cases

Scenario 1: New Team Member Onboarding

# Install company standards (once per machine)
aiconfig template install https://github.com/company/standards --as company --scope global

# Clone team project
git clone https://github.com/team/project.git && cd project

# Install project-specific templates
aiconfig template install https://github.com/team/backend-standards --as backend

# Set up MCP servers
aiconfig mcp install https://github.com/team/mcp-servers --as team-mcp
aiconfig mcp configure team-mcp
aiconfig mcp sync --tool all

Scenario 2: Applying Templates to Existing Project

# You're working on a project, discover useful templates
cd ~/projects/my-api

# Install templates immediately
aiconfig template install https://github.com/owasp/security-templates --as owasp

# Templates are now in .claude/rules/owasp.*
# AI assistant immediately knows these security patterns

Scenario 3: Solo Developer / Personal Use

# Install your personal tools globally (applies to all projects)
aiconfig template install https://github.com/yourname/my-tools --as personal --scope global

# Done! All your projects now have your preferred templates

Development

Running Tests

# Run all tests
invoke test

# Run with coverage
invoke test --coverage

# Code quality checks
invoke quality

# Auto-fix linting issues
invoke lint --fix

Project Structure

ai-config-kit/
โ”œโ”€โ”€ ai_tools/          # AI tool integrations (Claude, Cursor, etc.)
โ”œโ”€โ”€ cli/               # CLI commands
โ”œโ”€โ”€ core/              # Core business logic
โ”‚   โ”œโ”€โ”€ mcp/          # MCP server management
โ”‚   โ””โ”€โ”€ template/     # Template system
โ”œโ”€โ”€ storage/           # Data persistence
โ””โ”€โ”€ utils/             # Utilities

tests/
โ”œโ”€โ”€ unit/              # Unit tests
โ””โ”€โ”€ integration/       # Integration tests

Contributing

We welcome contributions! Here's how to get started:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (invoke test)
  5. Commit (git commit -m 'feat: add amazing feature')
  6. Push (git push origin feature/amazing-feature)
  7. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.


License

MIT License - see LICENSE for details.


Support


Made with โค๏ธ for AI-powered development teams

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

devsync-0.5.5.tar.gz (137.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

devsync-0.5.5-py3-none-any.whl (173.0 kB view details)

Uploaded Python 3

File details

Details for the file devsync-0.5.5.tar.gz.

File metadata

  • Download URL: devsync-0.5.5.tar.gz
  • Upload date:
  • Size: 137.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for devsync-0.5.5.tar.gz
Algorithm Hash digest
SHA256 eff363c8136657578bb8b4a2eb41976da0732b6611c55bafa27fdb5b2c036458
MD5 e646bafe7bcb6485fe3f95f7292be702
BLAKE2b-256 285f10678a13bee9a49e304d40f2f43157fec52742b820613458e264ff1be657

See more details on using hashes here.

File details

Details for the file devsync-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: devsync-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 173.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for devsync-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0b8db23f07c4b5947d641260952ce9eadef13fe781d7b5e4037fbc93083b53db
MD5 ed32dbcc819031c28cb601cc3130f4a7
BLAKE2b-256 96ba18382e07aa28309e4823f649c784d3c2a1ddb2e4a50875dda35476feb143

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page