@dallay/agentsync 1.19.0 → 1.21.0

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.
Files changed (2) hide show
  1. package/README.md +49 -3
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
  [![license](https://img.shields.io/npm/l/@dallay/agentsync.svg)](https://github.com/dallay/agentsync/blob/main/LICENSE)
5
5
  [![repository](https://img.shields.io/badge/repo-dallay%2Fagentsync-blue)](https://github.com/dallay/agentsync)
6
6
 
7
- **Version:** 1.14.2
7
+ **Version:** 1.19.0
8
8
  **License:** MIT
9
9
 
10
10
  Effortlessly synchronize AI agent configurations across tools like Copilot, Claude, Cursor, and other MCP-compatible servers using symbolic links and an intuitive CLI.
@@ -28,26 +28,31 @@ Effortlessly synchronize AI agent configurations across tools like Copilot, Clau
28
28
  Make sure you have Node.js (>=18) installed.
29
29
 
30
30
  ### Using `pnpm` (recommended):
31
+
31
32
  ```bash
32
33
  pnpm install -g @dallay/agentsync
33
34
  ```
34
35
 
35
36
  ### Using `npm`:
37
+
36
38
  ```bash
37
39
  npm install -g @dallay/agentsync
38
40
  ```
39
41
 
40
42
  ### Using `yarn`:
43
+
41
44
  ```bash
42
45
  yarn global add @dallay/agentsync
43
46
  ```
44
47
 
45
48
  ### Using `bun`:
49
+
46
50
  ```bash
47
51
  bun add -g @dallay/agentsync
48
52
  ```
49
53
 
50
54
  Verify installation:
55
+
51
56
  ```bash
52
57
  agentsync --help
53
58
  ```
@@ -59,13 +64,17 @@ agentsync --help
59
64
  ### Managing Configurations
60
65
 
61
66
  #### Sync Configurations:
67
+
62
68
  Run the following to create symbolic links across your AI coding assistants:
69
+
63
70
  ```bash
64
71
  agentsync apply
65
72
  ```
66
73
 
67
74
  #### Clean Configurations:
75
+
68
76
  Remove previously created symbolic links:
77
+
69
78
  ```bash
70
79
  agentsync clean
71
80
  ```
@@ -73,6 +82,7 @@ agentsync clean
73
82
  🎯 **Example Workflows**:
74
83
 
75
84
  - **Programmatic Usage in Node.js**:
85
+
76
86
  ```javascript
77
87
  const { main } = require('@dallay/agentsync');
78
88
 
@@ -85,6 +95,7 @@ agentsync clean
85
95
  - **Integrate with npm scripts**:
86
96
  Add configuration syncing to your npm scripts to automate process workflows.
87
97
  For example, in your `package.json`:
98
+
88
99
  ```json
89
100
  {
90
101
  "scripts": {
@@ -105,32 +116,67 @@ agentsync clean
105
116
 
106
117
  ## 👷 Development
107
118
 
119
+ This package is part of the [AgentSync mono-repo](https://github.com/dallay/agentsync). It serves as a Node.js wrapper for the high-performance Rust core.
120
+
108
121
  ### Prerequisites
122
+
109
123
  - [pnpm](https://pnpm.io/): Dependency manager.
110
- - [Node.js](https://nodejs.org/) >= 18.
124
+ - [Node.js](https://nodejs.org/) >= 24.13.0 (for development).
125
+ - [Rust](https://www.rust-lang.org/): For building the core CLI.
111
126
 
112
127
  ### Steps
128
+
113
129
  1. Clone the repository:
130
+
114
131
  ```bash
115
132
  git clone https://github.com/dallay/agentsync.git
116
133
  cd agentsync
117
134
  ```
118
135
 
119
136
  2. Install dependencies:
137
+
120
138
  ```bash
121
139
  pnpm install
122
140
  ```
123
141
 
124
142
  3. Build:
143
+
125
144
  ```bash
145
+ make js-build
146
+ # or
126
147
  pnpm run build
127
148
  ```
128
149
 
129
- 4. Run type checks:
150
+ 4. Run tests and type checks:
151
+
130
152
  ```bash
153
+ make js-test
154
+ # or
131
155
  pnpm run typecheck
132
156
  ```
133
157
 
158
+ 5. Format:
159
+
160
+ ```bash
161
+ make fmt
162
+ ```
163
+
164
+ ---
165
+
166
+ ## 🛠️ Troubleshooting
167
+
168
+ ### `PNPM_NO_MATURE_MATCHING_VERSION`
169
+
170
+ If `pnpm install` fails with this error, it's likely due to a strict package release age policy. You can try installing with `--ignore-scripts` or wait for the package to "mature" in the registry.
171
+
172
+ ### Lefthook installation failure
173
+
174
+ If `pnpm install` fails during the `lefthook` setup, you can try:
175
+
176
+ ```bash
177
+ pnpm install --ignore-scripts
178
+ ```
179
+
134
180
  ---
135
181
 
136
182
  ## 🌐 Resources
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dallay/agentsync",
3
- "version": "1.19.0",
3
+ "version": "1.21.0",
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,12 +41,12 @@
41
41
  "typescript": "^5.9.3"
42
42
  },
43
43
  "optionalDependencies": {
44
- "@dallay/agentsync-linux-x64": "1.19.0",
45
- "@dallay/agentsync-linux-arm64": "1.19.0",
46
- "@dallay/agentsync-darwin-x64": "1.19.0",
47
- "@dallay/agentsync-darwin-arm64": "1.19.0",
48
- "@dallay/agentsync-windows-x64": "1.19.0",
49
- "@dallay/agentsync-windows-arm64": "1.19.0"
44
+ "@dallay/agentsync-linux-x64": "1.21.0",
45
+ "@dallay/agentsync-linux-arm64": "1.21.0",
46
+ "@dallay/agentsync-darwin-x64": "1.21.0",
47
+ "@dallay/agentsync-darwin-arm64": "1.21.0",
48
+ "@dallay/agentsync-windows-x64": "1.21.0",
49
+ "@dallay/agentsync-windows-arm64": "1.21.0"
50
50
  },
51
51
  "engines": {
52
52
  "node": ">=18"