@dallay/agentsync 1.14.2 → 1.14.4
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.
- package/README.md +115 -97
- package/lib/index.js +3 -1
- package/lib/index.js.map +1 -1
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -1,132 +1,150 @@
|
|
|
1
1
|
# @dallay/agentsync
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@dallay/agentsync)
|
|
4
|
+
[](https://github.com/dallay/agentsync/blob/main/LICENSE)
|
|
5
|
+
[](https://github.com/dallay/agentsync)
|
|
4
6
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
[](https://github.com/dallay/agentsync)
|
|
7
|
+
**Version:** 1.14.2
|
|
8
|
+
**License:** MIT
|
|
8
9
|
|
|
9
|
-
|
|
10
|
-
-------
|
|
11
|
-
agentsync helps you keep AI agent configuration files synchronized across multiple AI coding assistants (e.g. Copilot, Claude, Gemini) by managing symbolic links and a simple CLI.
|
|
10
|
+
Effortlessly synchronize AI agent configurations across tools like Copilot, Claude, Cursor, and other MCP-compatible servers using symbolic links and an intuitive CLI.
|
|
12
11
|
|
|
13
|
-
|
|
14
|
-
-----------
|
|
15
|
-
- Repository: https://github.com/dallay/agentsync
|
|
16
|
-
- Issues: https://github.com/dallay/agentsync/issues
|
|
12
|
+
🌟 **[Explore the Full Documentation Here](https://dallay.github.io/agentsync/)**
|
|
17
13
|
|
|
18
|
-
|
|
19
|
-
------------
|
|
20
|
-
Install locally with pnpm (recommended):
|
|
14
|
+
---
|
|
21
15
|
|
|
22
|
-
|
|
16
|
+
## ✨ Key Features
|
|
23
17
|
|
|
24
|
-
|
|
18
|
+
- **Simple CLI**: Manage symbolic links with minimal setup.
|
|
19
|
+
- **Multi-assistant support**: Compatible across Copilot, Claude, Gemini, and more.
|
|
20
|
+
- **Cross-platform binaries**: Available for Linux, MacOS, and Windows.
|
|
21
|
+
- **Node.js integration**: Use programmatically within your applications.
|
|
25
22
|
|
|
26
|
-
|
|
23
|
+
---
|
|
27
24
|
|
|
28
|
-
|
|
25
|
+
## 🚀 Installation
|
|
29
26
|
|
|
30
|
-
|
|
27
|
+
Make sure you have Node.js (>=18) installed.
|
|
31
28
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
29
|
+
### Using `pnpm` (recommended):
|
|
30
|
+
```bash
|
|
31
|
+
pnpm install -g @dallay/agentsync
|
|
32
|
+
```
|
|
35
33
|
|
|
36
|
-
|
|
34
|
+
### Using `npm`:
|
|
35
|
+
```bash
|
|
36
|
+
npm install -g @dallay/agentsync
|
|
37
|
+
```
|
|
37
38
|
|
|
38
|
-
|
|
39
|
+
### Using `yarn`:
|
|
40
|
+
```bash
|
|
41
|
+
yarn global add @dallay/agentsync
|
|
42
|
+
```
|
|
39
43
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
- Validate existing symlinks and report missing or broken links.
|
|
44
|
-
- Export or import agent configurations.
|
|
45
|
-
|
|
46
|
-
Configuration
|
|
47
|
-
-------------
|
|
48
|
-
agentsync uses a small configuration file to define sources and targets for synchronization. Example (adjust to your environment):
|
|
49
|
-
|
|
50
|
-
```json
|
|
51
|
-
{
|
|
52
|
-
"sources": [
|
|
53
|
-
"~/.config/agents/common",
|
|
54
|
-
"./shared-agent-configs"
|
|
55
|
-
],
|
|
56
|
-
"targets": {
|
|
57
|
-
"copilot": "~/.config/copilot/agents",
|
|
58
|
-
"claude": "~/.config/claude/agents",
|
|
59
|
-
"gemini": "~/.config/gemini/agents"
|
|
60
|
-
},
|
|
61
|
-
"options": {
|
|
62
|
-
"dryRun": false,
|
|
63
|
-
"force": false
|
|
64
|
-
}
|
|
65
|
-
}
|
|
44
|
+
### Using `bun`:
|
|
45
|
+
```bash
|
|
46
|
+
bun add -g @dallay/agentsync
|
|
66
47
|
```
|
|
67
48
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
49
|
+
Verify installation:
|
|
50
|
+
```bash
|
|
51
|
+
agentsync --help
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## 🛠️ Usage
|
|
57
|
+
|
|
58
|
+
### Managing Configurations
|
|
71
59
|
|
|
72
|
-
|
|
60
|
+
#### Sync Configurations:
|
|
61
|
+
Run the following to create symbolic links across your AI coding assistants:
|
|
62
|
+
```bash
|
|
63
|
+
agentsync apply
|
|
64
|
+
```
|
|
73
65
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
console.error(err);
|
|
79
|
-
process.exit(1);
|
|
80
|
-
});
|
|
66
|
+
#### Clean Configurations:
|
|
67
|
+
Remove previously created symbolic links:
|
|
68
|
+
```bash
|
|
69
|
+
agentsync clean
|
|
81
70
|
```
|
|
82
71
|
|
|
83
|
-
|
|
72
|
+
🎯 **Example Workflows**:
|
|
73
|
+
|
|
74
|
+
- **Programmatic Usage in Node.js**:
|
|
75
|
+
```javascript
|
|
76
|
+
const { main } = require('@dallay/agentsync');
|
|
77
|
+
|
|
78
|
+
main(['apply']).catch((error) => {
|
|
79
|
+
console.error(error);
|
|
80
|
+
process.exit(1);
|
|
81
|
+
});
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
- **Integrate with npm scripts**:
|
|
85
|
+
Add configuration syncing to your npm scripts to automate process workflows.
|
|
86
|
+
For example, in your `package.json`:
|
|
87
|
+
```json
|
|
88
|
+
{
|
|
89
|
+
"scripts": {
|
|
90
|
+
"precommit": "pnpm exec agentsync apply --dry-run",
|
|
91
|
+
"prepare": "pnpm exec agentsync apply"
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
- For complex workflows, see the [detailed API documentation](https://dallay.github.io/agentsync/).
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 👷 Development
|
|
101
|
+
|
|
102
|
+
### Prerequisites
|
|
103
|
+
- [pnpm](https://pnpm.io/): Dependency manager.
|
|
104
|
+
- [Node.js](https://nodejs.org/) >= 18.
|
|
105
|
+
|
|
106
|
+
### Steps
|
|
107
|
+
1. Clone the repository:
|
|
108
|
+
```bash
|
|
109
|
+
git clone https://github.com/dallay/agentsync.git
|
|
110
|
+
cd agentsync
|
|
111
|
+
```
|
|
84
112
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
113
|
+
2. Install dependencies:
|
|
114
|
+
```bash
|
|
115
|
+
pnpm install
|
|
116
|
+
```
|
|
88
117
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
pnpm run build
|
|
118
|
+
3. Build:
|
|
119
|
+
```bash
|
|
120
|
+
pnpm run build
|
|
121
|
+
```
|
|
92
122
|
|
|
93
|
-
|
|
123
|
+
4. Run type checks:
|
|
124
|
+
```bash
|
|
125
|
+
pnpm run typecheck
|
|
126
|
+
```
|
|
94
127
|
|
|
95
|
-
|
|
96
|
-
- build — tsc
|
|
97
|
-
- clean — remove generated `lib/`
|
|
128
|
+
---
|
|
98
129
|
|
|
99
|
-
|
|
100
|
-
----------
|
|
101
|
-
This package is published to npm as @dallay/agentsync. The repository sets `publishConfig.access=public`.
|
|
130
|
+
## 🌐 Resources
|
|
102
131
|
|
|
103
|
-
|
|
132
|
+
- **Project Repository**: [GitHub Repository](https://github.com/dallay/agentsync)
|
|
133
|
+
- **Submit Issues**: [GitHub Issues](https://github.com/dallay/agentsync/issues)
|
|
134
|
+
- **Explore Full Documentation**: [Documentation Website](https://dallay.github.io/agentsync/)
|
|
104
135
|
|
|
105
|
-
|
|
106
|
-
2. Verify package.json fields: `main`, `files`, `bin`, `repository`, `bugs`, `homepage`.
|
|
107
|
-
3. Ensure LICENSE is present and tests/CI are green.
|
|
136
|
+
---
|
|
108
137
|
|
|
109
|
-
|
|
138
|
+
## 📜 License
|
|
110
139
|
|
|
111
|
-
|
|
112
|
-
------------
|
|
113
|
-
Contributions welcome. Keep it simple:
|
|
140
|
+
MIT License. See the [LICENSE](https://github.com/dallay/agentsync/blob/main/LICENSE) for details.
|
|
114
141
|
|
|
115
|
-
|
|
116
|
-
2. pnpm install
|
|
117
|
-
3. pnpm run typecheck && pnpm run build
|
|
118
|
-
4. Open a PR with a clear description and link to any related issue.
|
|
142
|
+
---
|
|
119
143
|
|
|
120
|
-
|
|
144
|
+
## 🙏 Acknowledgments
|
|
121
145
|
|
|
122
|
-
|
|
123
|
-
--------
|
|
124
|
-
Report security issues by opening a private issue on the repository or emailing the maintainer listed in package.json.
|
|
146
|
+
Special thanks to the developer community for their contributions and feedback. For suggestions and improvements, feel free to open a pull request!
|
|
125
147
|
|
|
126
|
-
|
|
127
|
-
-------
|
|
128
|
-
MIT — see LICENSE
|
|
148
|
+
---
|
|
129
149
|
|
|
130
|
-
|
|
131
|
-
------------------
|
|
132
|
-
For full API docs and examples, generate TypeDoc or add an `docs/` or `examples/` directory. If you want, I can generate a TypeDoc-based docs bundle and add CI to publish it to GitHub Pages.
|
|
150
|
+
📣 Ready? Start syncing agent configs today with `@dallay/agentsync`!
|
package/lib/index.js
CHANGED
|
@@ -38,7 +38,9 @@ function getExePath() {
|
|
|
38
38
|
throw new Error(`Unsupported platform: ${platformKey}\n\nSupported platforms:\n${supportedPlatforms}\n\nPlease open an issue at https://github.com/dallay/agentsync/issues`);
|
|
39
39
|
}
|
|
40
40
|
// Determine binary name (with .exe on Windows and Cygwin)
|
|
41
|
-
const binaryName = platform === "win32" || platform === "cygwin"
|
|
41
|
+
const binaryName = platform === "win32" || platform === "cygwin"
|
|
42
|
+
? "agentsync.exe"
|
|
43
|
+
: "agentsync";
|
|
42
44
|
// Try to resolve the binary from the platform-specific package
|
|
43
45
|
let binaryPath;
|
|
44
46
|
try {
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,iDAA0C;AAC1C,2BAAgC;AAChC,+BAA4B;AAE5B;;GAEG;AACH,MAAM,SAAS,GAA2B;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,iDAA0C;AAC1C,2BAAgC;AAChC,+BAA4B;AAE5B;;GAEG;AACH,MAAM,SAAS,GAA2B;IACzC,YAAY,EAAE,8BAA8B;IAC5C,cAAc,EAAE,gCAAgC;IAChD,WAAW,EAAE,6BAA6B;IAC1C,aAAa,EAAE,+BAA+B;IAC9C,WAAW,EAAE,+BAA+B;IAC5C,aAAa,EAAE,iCAAiC;IAChD,YAAY,EAAE,+BAA+B;IAC7C,cAAc,EAAE,iCAAiC;CACjD,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAS,UAAU;IAClB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1B,MAAM,WAAW,GAAG,GAAG,QAAQ,IAAI,IAAI,EAAE,CAAC;IAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;IAE3C,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aAC/C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;aACtB,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,MAAM,IAAI,KAAK,CACd,yBAAyB,WAAW,6BAA6B,kBAAkB,wEAAwE,CAC3J,CAAC;IACH,CAAC;IAED,0DAA0D;IAC1D,MAAM,UAAU,GACf,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,QAAQ;QAC5C,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,WAAW,CAAC;IAEhB,+DAA+D;IAC/D,IAAI,UAAkB,CAAC;IAEvB,IAAI,CAAC;QACJ,2DAA2D;QAC3D,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,WAAW,eAAe,CAAC,CAAC;QACnE,UAAU,GAAG,IAAA,WAAI,EAAC,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACzD,CAAC;IAAC,MAAM,CAAC;QACR,oDAAoD;QACpD,UAAU,GAAG,IAAA,WAAI,EAChB,SAAS,EACT,IAAI,EACJ,cAAc,EACd,WAAW,EACX,KAAK,EACL,UAAU,CACV,CAAC;IACH,CAAC;IAED,IAAI,CAAC,IAAA,eAAU,EAAC,UAAU,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACd,uCAAuC,UAAU,MAAM;YACtD,qDAAqD,WAAW,wBAAwB;YACxF,0DAA0D;YAC1D,6FAA6F,CAC9F,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,SAAS,GAAG;IACX,IAAI,UAAkB,CAAC;IAEvB,IAAI,CAAC;QACJ,UAAU,GAAG,UAAU,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,UAAW,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,+DAA+D;IAC/D,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEnC,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,UAAU,EAAE,IAAI,EAAE;QAC1C,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;KAChB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,gCAAgC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACtE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,wCAAwC;IACxC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,GAAG,EAAE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dallay/agentsync",
|
|
3
|
-
"version": "1.14.
|
|
3
|
+
"version": "1.14.4",
|
|
4
4
|
"description": "A fast CLI tool to sync AI agent configurations and MCP servers across Claude, Copilot, Cursor, and more using symbolic links.",
|
|
5
5
|
"author": "Yuniel Acosta <yunielacosta738@gmail.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -41,17 +41,18 @@
|
|
|
41
41
|
"typescript": "^5.9.3"
|
|
42
42
|
},
|
|
43
43
|
"optionalDependencies": {
|
|
44
|
-
"@dallay/agentsync-linux-x64": "1.14.
|
|
45
|
-
"@dallay/agentsync-linux-arm64": "1.14.
|
|
46
|
-
"@dallay/agentsync-darwin-x64": "1.14.
|
|
47
|
-
"@dallay/agentsync-darwin-arm64": "1.14.
|
|
48
|
-
"@dallay/agentsync-windows-x64": "1.14.
|
|
49
|
-
"@dallay/agentsync-windows-arm64": "1.14.
|
|
44
|
+
"@dallay/agentsync-linux-x64": "1.14.4",
|
|
45
|
+
"@dallay/agentsync-linux-arm64": "1.14.4",
|
|
46
|
+
"@dallay/agentsync-darwin-x64": "1.14.4",
|
|
47
|
+
"@dallay/agentsync-darwin-arm64": "1.14.4",
|
|
48
|
+
"@dallay/agentsync-windows-x64": "1.14.4",
|
|
49
|
+
"@dallay/agentsync-windows-arm64": "1.14.4"
|
|
50
50
|
},
|
|
51
51
|
"engines": {
|
|
52
52
|
"node": ">=18"
|
|
53
53
|
},
|
|
54
54
|
"scripts": {
|
|
55
|
+
"test": "pnpm run typecheck",
|
|
55
56
|
"typecheck": "tsc --noEmit",
|
|
56
57
|
"build": "tsc",
|
|
57
58
|
"clean": "node -e \"require('fs').rmSync('lib', {recursive: true, force: true})\""
|