devsync 0.5.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- devsync-0.5.5/LICENSE +21 -0
- devsync-0.5.5/PKG-INFO +477 -0
- devsync-0.5.5/README.md +439 -0
- devsync-0.5.5/aiconfigkit/__init__.py +0 -0
- devsync-0.5.5/aiconfigkit/__main__.py +6 -0
- devsync-0.5.5/aiconfigkit/ai_tools/__init__.py +0 -0
- devsync-0.5.5/aiconfigkit/ai_tools/base.py +236 -0
- devsync-0.5.5/aiconfigkit/ai_tools/capability_registry.py +262 -0
- devsync-0.5.5/aiconfigkit/ai_tools/claude.py +91 -0
- devsync-0.5.5/aiconfigkit/ai_tools/claude_desktop.py +97 -0
- devsync-0.5.5/aiconfigkit/ai_tools/cline.py +92 -0
- devsync-0.5.5/aiconfigkit/ai_tools/copilot.py +92 -0
- devsync-0.5.5/aiconfigkit/ai_tools/cursor.py +109 -0
- devsync-0.5.5/aiconfigkit/ai_tools/detector.py +169 -0
- devsync-0.5.5/aiconfigkit/ai_tools/kiro.py +85 -0
- devsync-0.5.5/aiconfigkit/ai_tools/mcp_syncer.py +291 -0
- devsync-0.5.5/aiconfigkit/ai_tools/roo.py +110 -0
- devsync-0.5.5/aiconfigkit/ai_tools/translator.py +390 -0
- devsync-0.5.5/aiconfigkit/ai_tools/winsurf.py +102 -0
- devsync-0.5.5/aiconfigkit/cli/__init__.py +0 -0
- devsync-0.5.5/aiconfigkit/cli/delete.py +118 -0
- devsync-0.5.5/aiconfigkit/cli/download.py +274 -0
- devsync-0.5.5/aiconfigkit/cli/install.py +237 -0
- devsync-0.5.5/aiconfigkit/cli/install_new.py +937 -0
- devsync-0.5.5/aiconfigkit/cli/list.py +275 -0
- devsync-0.5.5/aiconfigkit/cli/main.py +454 -0
- devsync-0.5.5/aiconfigkit/cli/mcp_configure.py +232 -0
- devsync-0.5.5/aiconfigkit/cli/mcp_install.py +166 -0
- devsync-0.5.5/aiconfigkit/cli/mcp_sync.py +165 -0
- devsync-0.5.5/aiconfigkit/cli/package.py +383 -0
- devsync-0.5.5/aiconfigkit/cli/package_create.py +323 -0
- devsync-0.5.5/aiconfigkit/cli/package_install.py +472 -0
- devsync-0.5.5/aiconfigkit/cli/template.py +19 -0
- devsync-0.5.5/aiconfigkit/cli/template_backup.py +261 -0
- devsync-0.5.5/aiconfigkit/cli/template_init.py +499 -0
- devsync-0.5.5/aiconfigkit/cli/template_install.py +261 -0
- devsync-0.5.5/aiconfigkit/cli/template_list.py +172 -0
- devsync-0.5.5/aiconfigkit/cli/template_uninstall.py +146 -0
- devsync-0.5.5/aiconfigkit/cli/template_update.py +225 -0
- devsync-0.5.5/aiconfigkit/cli/template_validate.py +234 -0
- devsync-0.5.5/aiconfigkit/cli/tools.py +47 -0
- devsync-0.5.5/aiconfigkit/cli/uninstall.py +125 -0
- devsync-0.5.5/aiconfigkit/cli/update.py +309 -0
- devsync-0.5.5/aiconfigkit/core/__init__.py +0 -0
- devsync-0.5.5/aiconfigkit/core/checksum.py +211 -0
- devsync-0.5.5/aiconfigkit/core/component_detector.py +905 -0
- devsync-0.5.5/aiconfigkit/core/conflict_resolution.py +329 -0
- devsync-0.5.5/aiconfigkit/core/git_operations.py +539 -0
- devsync-0.5.5/aiconfigkit/core/mcp/__init__.py +1 -0
- devsync-0.5.5/aiconfigkit/core/mcp/credentials.py +279 -0
- devsync-0.5.5/aiconfigkit/core/mcp/manager.py +308 -0
- devsync-0.5.5/aiconfigkit/core/mcp/set_manager.py +1 -0
- devsync-0.5.5/aiconfigkit/core/mcp/validator.py +1 -0
- devsync-0.5.5/aiconfigkit/core/models.py +1661 -0
- devsync-0.5.5/aiconfigkit/core/package_creator.py +743 -0
- devsync-0.5.5/aiconfigkit/core/package_manifest.py +248 -0
- devsync-0.5.5/aiconfigkit/core/repository.py +298 -0
- devsync-0.5.5/aiconfigkit/core/secret_detector.py +438 -0
- devsync-0.5.5/aiconfigkit/core/template_manifest.py +283 -0
- devsync-0.5.5/aiconfigkit/core/version.py +201 -0
- devsync-0.5.5/aiconfigkit/storage/__init__.py +0 -0
- devsync-0.5.5/aiconfigkit/storage/library.py +429 -0
- devsync-0.5.5/aiconfigkit/storage/mcp_tracker.py +1 -0
- devsync-0.5.5/aiconfigkit/storage/package_tracker.py +234 -0
- devsync-0.5.5/aiconfigkit/storage/template_library.py +229 -0
- devsync-0.5.5/aiconfigkit/storage/template_tracker.py +296 -0
- devsync-0.5.5/aiconfigkit/storage/tracker.py +416 -0
- devsync-0.5.5/aiconfigkit/tui/__init__.py +5 -0
- devsync-0.5.5/aiconfigkit/tui/installer.py +511 -0
- devsync-0.5.5/aiconfigkit/utils/__init__.py +0 -0
- devsync-0.5.5/aiconfigkit/utils/atomic_write.py +90 -0
- devsync-0.5.5/aiconfigkit/utils/backup.py +169 -0
- devsync-0.5.5/aiconfigkit/utils/dotenv.py +128 -0
- devsync-0.5.5/aiconfigkit/utils/git_helpers.py +187 -0
- devsync-0.5.5/aiconfigkit/utils/logging.py +60 -0
- devsync-0.5.5/aiconfigkit/utils/namespace.py +134 -0
- devsync-0.5.5/aiconfigkit/utils/paths.py +205 -0
- devsync-0.5.5/aiconfigkit/utils/project.py +109 -0
- devsync-0.5.5/aiconfigkit/utils/streaming.py +216 -0
- devsync-0.5.5/aiconfigkit/utils/ui.py +194 -0
- devsync-0.5.5/aiconfigkit/utils/validation.py +187 -0
- devsync-0.5.5/devsync.egg-info/PKG-INFO +477 -0
- devsync-0.5.5/devsync.egg-info/SOURCES.txt +87 -0
- devsync-0.5.5/devsync.egg-info/dependency_links.txt +1 -0
- devsync-0.5.5/devsync.egg-info/entry_points.txt +2 -0
- devsync-0.5.5/devsync.egg-info/requires.txt +17 -0
- devsync-0.5.5/devsync.egg-info/top_level.txt +1 -0
- devsync-0.5.5/pyproject.toml +85 -0
- devsync-0.5.5/setup.cfg +4 -0
devsync-0.5.5/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 InstructionKit Team
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
devsync-0.5.5/PKG-INFO
ADDED
|
@@ -0,0 +1,477 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: devsync
|
|
3
|
+
Version: 0.5.5
|
|
4
|
+
Summary: Distribute and sync dev tool configurations across teams
|
|
5
|
+
Author-email: Troy Larson <troy@calvinware.com>
|
|
6
|
+
License: MIT License
|
|
7
|
+
Project-URL: Homepage, https://github.com/troylar/config-sync
|
|
8
|
+
Project-URL: Documentation, https://github.com/troylar/config-sync#readme
|
|
9
|
+
Project-URL: Repository, https://github.com/troylar/config-sync
|
|
10
|
+
Project-URL: Issues, https://github.com/troylar/config-sync/issues
|
|
11
|
+
Keywords: cli,ai,config,mcp,cursor,copilot,claude,cline,kiro,roo,windsurf
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Requires-Python: >=3.10
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
Requires-Dist: typer[all]>=0.15.0
|
|
23
|
+
Requires-Dist: rich>=14.0.0
|
|
24
|
+
Requires-Dist: pyyaml>=6.0
|
|
25
|
+
Requires-Dist: textual>=6.0.0
|
|
26
|
+
Requires-Dist: GitPython>=3.1.45
|
|
27
|
+
Requires-Dist: python-dotenv>=1.0.0
|
|
28
|
+
Provides-Extra: dev
|
|
29
|
+
Requires-Dist: pytest>=8.0.0; extra == "dev"
|
|
30
|
+
Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
|
|
31
|
+
Requires-Dist: black==24.10.0; extra == "dev"
|
|
32
|
+
Requires-Dist: mypy>=1.10.0; extra == "dev"
|
|
33
|
+
Requires-Dist: ruff>=0.9.0; extra == "dev"
|
|
34
|
+
Requires-Dist: invoke>=2.0.0; extra == "dev"
|
|
35
|
+
Requires-Dist: build>=1.2.1; extra == "dev"
|
|
36
|
+
Requires-Dist: twine>=5.0.0; extra == "dev"
|
|
37
|
+
Requires-Dist: types-PyYAML>=6.0.12.20240808; extra == "dev"
|
|
38
|
+
|
|
39
|
+
<div align="center">
|
|
40
|
+
|
|
41
|
+
# 🎯 Config Sync
|
|
42
|
+
|
|
43
|
+
**Distribute and sync coding standards, AI tool configurations, and MCP servers across your team**
|
|
44
|
+
|
|
45
|
+
[](https://github.com/troylar/config-sync/actions/workflows/ci.yml)
|
|
46
|
+
[](https://codecov.io/gh/troylar/config-sync)
|
|
47
|
+
[](https://pypi.org/project/configsync/)
|
|
48
|
+
[](https://www.python.org/downloads/)
|
|
49
|
+
[](https://opensource.org/licenses/MIT)
|
|
50
|
+
|
|
51
|
+
**Works with:** Claude Code • Claude Desktop • Cline • Cursor • GitHub Copilot • Kiro • Roo Code • Windsurf
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## What is Config Sync?
|
|
58
|
+
|
|
59
|
+
Config Sync is a CLI tool for distributing and managing AI coding assistant configurations across teams:
|
|
60
|
+
|
|
61
|
+
- **📋 Templates**: Share coding standards, slash commands, and IDE configurations from Git repositories
|
|
62
|
+
- **🔌 MCP Servers**: Distribute and manage Model Context Protocol server configurations
|
|
63
|
+
- **🔄 Sync**: Keep your team aligned with single-command updates
|
|
64
|
+
- **✅ Safe**: Built-in validation, automatic backups, conflict resolution
|
|
65
|
+
|
|
66
|
+
> **Note:** Commands use `aiconfig` (short for Config Sync)
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## 🚀 Quick Start
|
|
71
|
+
|
|
72
|
+
### Install
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
pip install configsync
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Templates: Share Coding Standards (30 seconds)
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
# Navigate to where you want to create the template
|
|
82
|
+
cd ~/projects # or your preferred location
|
|
83
|
+
|
|
84
|
+
# Create template repository (creates 'my-standards' directory here)
|
|
85
|
+
aiconfig template init my-standards
|
|
86
|
+
|
|
87
|
+
# Work inside it and install locally to test
|
|
88
|
+
cd my-standards
|
|
89
|
+
aiconfig template install . --as demo
|
|
90
|
+
|
|
91
|
+
# Your IDE now has coding standards in .claude/rules/demo.*
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### MCP: Configure AI Tool Servers (2 minutes)
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
# Install MCP server configurations from a repository
|
|
98
|
+
aiconfig mcp install https://github.com/company/mcp-servers --as backend
|
|
99
|
+
|
|
100
|
+
# Configure credentials securely (stored in gitignored .env)
|
|
101
|
+
aiconfig mcp configure backend
|
|
102
|
+
|
|
103
|
+
# Sync to AI tools (Claude Desktop, Cursor, Windsurf)
|
|
104
|
+
aiconfig mcp sync --tool all
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Packages: Install Complete Development Setups (1 minute)
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
# Install a complete package with instructions, hooks, and commands
|
|
111
|
+
aiconfig package install ./example-package --ide claude
|
|
112
|
+
|
|
113
|
+
# List installed packages
|
|
114
|
+
aiconfig package list
|
|
115
|
+
|
|
116
|
+
# Your IDE now has everything: instructions, MCP servers, hooks, commands
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Core Features
|
|
122
|
+
|
|
123
|
+
### 🎨 Template System
|
|
124
|
+
|
|
125
|
+
Distribute any IDE-specific content from Git repositories:
|
|
126
|
+
|
|
127
|
+
- **Coding Standards** → `.claude/rules/` (instructions for AI)
|
|
128
|
+
- **Slash Commands** → `.claude/commands/` (accessible as `/command-name`)
|
|
129
|
+
- **IDE Hooks** → Pre/post prompt automation
|
|
130
|
+
- **Any Configuration** → Snippets, settings, etc.
|
|
131
|
+
|
|
132
|
+
**Key Commands:**
|
|
133
|
+
```bash
|
|
134
|
+
aiconfig template install <repo> --as <namespace> # Install templates
|
|
135
|
+
aiconfig template list # Show installed templates
|
|
136
|
+
aiconfig template update <namespace> # Update to latest version
|
|
137
|
+
aiconfig template uninstall <namespace> # Remove templates
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
[📖 Full Template Documentation →](docs/templates.md)
|
|
141
|
+
|
|
142
|
+
### 🔌 MCP Server Management
|
|
143
|
+
|
|
144
|
+
Manage Model Context Protocol servers across your team:
|
|
145
|
+
|
|
146
|
+
- **Share Configurations** → Distribute MCP server setups via Git
|
|
147
|
+
- **Secure Credentials** → Store secrets in gitignored `.env` files
|
|
148
|
+
- **Multi-Tool Sync** → One command syncs to Claude Code, Claude Desktop, Cursor, Windsurf
|
|
149
|
+
- **Environment Resolution** → Automatically inject credentials at sync time
|
|
150
|
+
|
|
151
|
+
**Supported IDEs:**
|
|
152
|
+
| IDE | MCP Config Location | Tool Limit |
|
|
153
|
+
|-----|---------------------|------------|
|
|
154
|
+
| Claude Code | `.claude/settings.local.json` | Unlimited |
|
|
155
|
+
| Claude Desktop | `~/Library/Application Support/Claude/claude_desktop_config.json` | Unlimited |
|
|
156
|
+
| Cursor | `.cursor/mcp.json` or `~/.cursor/mcp.json` | 40 tools |
|
|
157
|
+
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | 100 tools |
|
|
158
|
+
| GitHub Copilot | `.vscode/mcp.json` | 128 tools |
|
|
159
|
+
|
|
160
|
+
**Key Commands:**
|
|
161
|
+
```bash
|
|
162
|
+
aiconfig mcp install <repo> --as <namespace> # Install MCP configs
|
|
163
|
+
aiconfig mcp configure <namespace> # Set up credentials
|
|
164
|
+
aiconfig mcp sync --tool all # Sync to AI tools
|
|
165
|
+
aiconfig mcp list # Show installed servers
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
[📖 Full MCP Documentation →](docs/mcp.md)
|
|
169
|
+
|
|
170
|
+
### 📦 Configuration Packages
|
|
171
|
+
|
|
172
|
+
Bundle and distribute complete AI assistant configurations:
|
|
173
|
+
|
|
174
|
+
- **Multi-Component Packages** → Combine instructions, MCP servers, hooks, commands, skills, workflows
|
|
175
|
+
- **IDE-Aware Installation** → Automatically adapts to target IDE capabilities
|
|
176
|
+
- **Package Creation** → Generate packages from existing project configurations
|
|
177
|
+
- **Secret Detection** → Automatically templates secrets in MCP configs
|
|
178
|
+
- **Conflict Resolution** → Handle existing files with skip, overwrite, or rename strategies
|
|
179
|
+
|
|
180
|
+
**Key Commands:**
|
|
181
|
+
```bash
|
|
182
|
+
aiconfig package create --name my-pkg # Create package from project
|
|
183
|
+
aiconfig package install <package-path> --ide <ide> # Install package
|
|
184
|
+
aiconfig package list # Show installed packages
|
|
185
|
+
aiconfig package uninstall <package-name> # Remove package
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
[📖 Full Package Documentation →](docs/packages/)
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## Why Config Sync?
|
|
193
|
+
|
|
194
|
+
### For Teams
|
|
195
|
+
|
|
196
|
+
✅ **Consistency** - Everyone uses the same standards and tools
|
|
197
|
+
✅ **Onboarding** - New members get configured in minutes
|
|
198
|
+
✅ **Compliance** - Enforce security policies and code review checklists
|
|
199
|
+
✅ **No Secrets in Git** - Credentials stay local, configs are shared
|
|
200
|
+
|
|
201
|
+
### For Individuals
|
|
202
|
+
|
|
203
|
+
✅ **Portable** - Same setup across all your machines
|
|
204
|
+
✅ **Composable** - Mix company + team + personal configurations
|
|
205
|
+
✅ **Discoverable** - Install templates from any Git repository
|
|
206
|
+
✅ **Safe** - Automatic backups, conflict resolution, validation
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
## Real-World Example
|
|
211
|
+
|
|
212
|
+
Here's how a team at ACME Corp uses Config Sync:
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
# 1. Everyone installs company security policies (global, applies to all projects)
|
|
216
|
+
aiconfig template install https://github.com/acme/security-policy --as acme-security --scope global
|
|
217
|
+
|
|
218
|
+
# 2. Backend team members clone their project
|
|
219
|
+
git clone https://github.com/acme/backend-api.git && cd backend-api
|
|
220
|
+
|
|
221
|
+
# 3. Install team-specific templates (project scope)
|
|
222
|
+
aiconfig template install https://github.com/acme/backend-standards --as backend
|
|
223
|
+
aiconfig template install https://github.com/acme/python-patterns --as python
|
|
224
|
+
|
|
225
|
+
# 4. Install and configure MCP servers (for enhanced AI capabilities)
|
|
226
|
+
aiconfig mcp install https://github.com/acme/mcp-servers --as backend-mcp
|
|
227
|
+
aiconfig mcp configure backend-mcp
|
|
228
|
+
aiconfig mcp sync --tool claude
|
|
229
|
+
|
|
230
|
+
# Done! IDE now has:
|
|
231
|
+
# - Global security rules (all projects)
|
|
232
|
+
# - Backend coding standards (this project)
|
|
233
|
+
# - Python patterns (this project)
|
|
234
|
+
# - MCP servers configured (Claude Desktop, Cursor, etc.)
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
Team members update everything with:
|
|
238
|
+
```bash
|
|
239
|
+
aiconfig template update --all
|
|
240
|
+
aiconfig mcp update --all
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Documentation
|
|
246
|
+
|
|
247
|
+
| Guide | Description |
|
|
248
|
+
|-------|-------------|
|
|
249
|
+
| [**Templates**](docs/templates.md) | Comprehensive guide to the template system |
|
|
250
|
+
| [**MCP Servers**](docs/mcp.md) | Managing Model Context Protocol servers |
|
|
251
|
+
| [**Packages**](docs/packages/) | Complete package management guide (install, create, manage) |
|
|
252
|
+
| [**CLI Reference**](docs/cli-reference.md) | Complete command reference |
|
|
253
|
+
| [**Advanced Usage**](docs/advanced.md) | Scopes, namespaces, conflict resolution |
|
|
254
|
+
| [**Creating Templates**](docs/creating-templates.md) | How to build your own template repositories |
|
|
255
|
+
|
|
256
|
+
---
|
|
257
|
+
|
|
258
|
+
## Project vs Global Scope
|
|
259
|
+
|
|
260
|
+
Config Sync supports two installation scopes:
|
|
261
|
+
|
|
262
|
+
| Scope | Where Files Go | When Active | Best For |
|
|
263
|
+
|-------|---------------|-------------|----------|
|
|
264
|
+
| **Project** (default) | `<project>/.claude/rules/`<br>`<project>/.ai-config-kit/` | Only in that project | Team practices, project standards |
|
|
265
|
+
| **Global** | `~/.claude/rules/`<br>`~/.ai-config-kit/` | All projects | Personal tools, company policies |
|
|
266
|
+
|
|
267
|
+
**Example:**
|
|
268
|
+
```bash
|
|
269
|
+
# Global: Company-wide security policy (applies everywhere)
|
|
270
|
+
aiconfig template install https://github.com/company/security --as security --scope global
|
|
271
|
+
|
|
272
|
+
# Project: Team-specific patterns (only this project)
|
|
273
|
+
cd ~/projects/backend-api
|
|
274
|
+
aiconfig template install https://github.com/team/backend-patterns --as backend
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
Your IDE gets **both**: global templates (always available) + project templates (context-specific).
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## What Can You Distribute?
|
|
282
|
+
|
|
283
|
+
### Templates
|
|
284
|
+
|
|
285
|
+
Any IDE-specific content from Git repositories:
|
|
286
|
+
|
|
287
|
+
- Coding standards and style guides
|
|
288
|
+
- Security checklists and compliance rules
|
|
289
|
+
- Custom slash commands (accessible as `/command-name`)
|
|
290
|
+
- Code review templates
|
|
291
|
+
- Architecture decision records (ADRs)
|
|
292
|
+
- Testing patterns and strategies
|
|
293
|
+
- IDE automation hooks (pre-prompt, post-prompt)
|
|
294
|
+
|
|
295
|
+
### Packages
|
|
296
|
+
|
|
297
|
+
Complete configuration bundles with multiple component types:
|
|
298
|
+
|
|
299
|
+
| Component | Claude | Cline | Cursor | Kiro | Roo Code | Windsurf | Copilot |
|
|
300
|
+
|-----------|--------|-------|--------|------|----------|----------|---------|
|
|
301
|
+
| Instructions | `.claude/rules/` | `.clinerules/` | `.cursor/rules/` | `.kiro/steering/` | `.roo/rules/` | `.windsurf/rules/` | `.github/instructions/` |
|
|
302
|
+
| MCP Servers | ✅ | ❌ | ✅ | ❌ | ✅ | ✅ | ✅ |
|
|
303
|
+
| Hooks | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
|
304
|
+
| Commands | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ |
|
|
305
|
+
| Skills | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
|
306
|
+
| Workflows | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |
|
|
307
|
+
| Memory Files | ✅ (CLAUDE.md) | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
|
308
|
+
| Resources | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
|
|
309
|
+
|
|
310
|
+
### MCP Server Configurations
|
|
311
|
+
|
|
312
|
+
Model Context Protocol server setups for enhanced AI capabilities:
|
|
313
|
+
|
|
314
|
+
- Database access (PostgreSQL, MySQL, SQLite)
|
|
315
|
+
- API integrations (GitHub, Jira, Slack)
|
|
316
|
+
- File system access with proper permissions
|
|
317
|
+
- Custom tools and commands
|
|
318
|
+
- Development environment connections
|
|
319
|
+
|
|
320
|
+
---
|
|
321
|
+
|
|
322
|
+
## Installation & Setup
|
|
323
|
+
|
|
324
|
+
### Requirements
|
|
325
|
+
|
|
326
|
+
- Python 3.10 or higher
|
|
327
|
+
- Git (for cloning template repositories)
|
|
328
|
+
- One of: Claude Code, Claude Desktop, Cline, Cursor, GitHub Copilot, Kiro, Roo Code, or Windsurf
|
|
329
|
+
|
|
330
|
+
### Install Config Sync
|
|
331
|
+
|
|
332
|
+
```bash
|
|
333
|
+
# Using pip
|
|
334
|
+
pip install configsync
|
|
335
|
+
|
|
336
|
+
# Verify installation
|
|
337
|
+
aiconfig --version
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### Quick Configuration
|
|
341
|
+
|
|
342
|
+
```bash
|
|
343
|
+
# Check which AI tools are installed
|
|
344
|
+
aiconfig tools
|
|
345
|
+
|
|
346
|
+
# Navigate to where you want to create templates
|
|
347
|
+
cd ~/projects # or your preferred location
|
|
348
|
+
|
|
349
|
+
# Create template repository (creates 'my-standards' directory here)
|
|
350
|
+
aiconfig template init my-standards
|
|
351
|
+
|
|
352
|
+
# Work inside it and install to test
|
|
353
|
+
cd my-standards
|
|
354
|
+
aiconfig template install . --as demo
|
|
355
|
+
|
|
356
|
+
# View installed templates
|
|
357
|
+
aiconfig template list
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
---
|
|
361
|
+
|
|
362
|
+
## Common Use Cases
|
|
363
|
+
|
|
364
|
+
### Scenario 1: New Team Member Onboarding
|
|
365
|
+
|
|
366
|
+
```bash
|
|
367
|
+
# Install company standards (once per machine)
|
|
368
|
+
aiconfig template install https://github.com/company/standards --as company --scope global
|
|
369
|
+
|
|
370
|
+
# Clone team project
|
|
371
|
+
git clone https://github.com/team/project.git && cd project
|
|
372
|
+
|
|
373
|
+
# Install project-specific templates
|
|
374
|
+
aiconfig template install https://github.com/team/backend-standards --as backend
|
|
375
|
+
|
|
376
|
+
# Set up MCP servers
|
|
377
|
+
aiconfig mcp install https://github.com/team/mcp-servers --as team-mcp
|
|
378
|
+
aiconfig mcp configure team-mcp
|
|
379
|
+
aiconfig mcp sync --tool all
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
### Scenario 2: Applying Templates to Existing Project
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
# You're working on a project, discover useful templates
|
|
386
|
+
cd ~/projects/my-api
|
|
387
|
+
|
|
388
|
+
# Install templates immediately
|
|
389
|
+
aiconfig template install https://github.com/owasp/security-templates --as owasp
|
|
390
|
+
|
|
391
|
+
# Templates are now in .claude/rules/owasp.*
|
|
392
|
+
# AI assistant immediately knows these security patterns
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### Scenario 3: Solo Developer / Personal Use
|
|
396
|
+
|
|
397
|
+
```bash
|
|
398
|
+
# Install your personal tools globally (applies to all projects)
|
|
399
|
+
aiconfig template install https://github.com/yourname/my-tools --as personal --scope global
|
|
400
|
+
|
|
401
|
+
# Done! All your projects now have your preferred templates
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
---
|
|
405
|
+
|
|
406
|
+
## Development
|
|
407
|
+
|
|
408
|
+
### Running Tests
|
|
409
|
+
|
|
410
|
+
```bash
|
|
411
|
+
# Run all tests
|
|
412
|
+
invoke test
|
|
413
|
+
|
|
414
|
+
# Run with coverage
|
|
415
|
+
invoke test --coverage
|
|
416
|
+
|
|
417
|
+
# Code quality checks
|
|
418
|
+
invoke quality
|
|
419
|
+
|
|
420
|
+
# Auto-fix linting issues
|
|
421
|
+
invoke lint --fix
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### Project Structure
|
|
425
|
+
|
|
426
|
+
```
|
|
427
|
+
ai-config-kit/
|
|
428
|
+
├── ai_tools/ # AI tool integrations (Claude, Cursor, etc.)
|
|
429
|
+
├── cli/ # CLI commands
|
|
430
|
+
├── core/ # Core business logic
|
|
431
|
+
│ ├── mcp/ # MCP server management
|
|
432
|
+
│ └── template/ # Template system
|
|
433
|
+
├── storage/ # Data persistence
|
|
434
|
+
└── utils/ # Utilities
|
|
435
|
+
|
|
436
|
+
tests/
|
|
437
|
+
├── unit/ # Unit tests
|
|
438
|
+
└── integration/ # Integration tests
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
---
|
|
442
|
+
|
|
443
|
+
## Contributing
|
|
444
|
+
|
|
445
|
+
We welcome contributions! Here's how to get started:
|
|
446
|
+
|
|
447
|
+
1. **Fork the repository**
|
|
448
|
+
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
|
|
449
|
+
3. **Make your changes**
|
|
450
|
+
4. **Run tests** (`invoke test`)
|
|
451
|
+
5. **Commit** (`git commit -m 'feat: add amazing feature'`)
|
|
452
|
+
6. **Push** (`git push origin feature/amazing-feature`)
|
|
453
|
+
7. **Open a Pull Request**
|
|
454
|
+
|
|
455
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
|
|
456
|
+
|
|
457
|
+
---
|
|
458
|
+
|
|
459
|
+
## License
|
|
460
|
+
|
|
461
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
462
|
+
|
|
463
|
+
---
|
|
464
|
+
|
|
465
|
+
## Support
|
|
466
|
+
|
|
467
|
+
- **Issues**: [GitHub Issues](https://github.com/troylar/config-sync/issues)
|
|
468
|
+
- **Discussions**: [GitHub Discussions](https://github.com/troylar/config-sync/discussions)
|
|
469
|
+
- **Changelog**: [CHANGELOG.md](CHANGELOG.md)
|
|
470
|
+
|
|
471
|
+
---
|
|
472
|
+
|
|
473
|
+
<div align="center">
|
|
474
|
+
|
|
475
|
+
**Made with ❤️ for AI-powered development teams**
|
|
476
|
+
|
|
477
|
+
</div>
|