@dallay/agentsync 1.8.2 → 1.13.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 +132 -0
  2. package/package.json +12 -10
package/README.md ADDED
@@ -0,0 +1,132 @@
1
+ # @dallay/agentsync
2
+
3
+ Sync AI agent configurations across multiple coding assistants using symbolic links.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@dallay/agentsync.svg)](https://www.npmjs.com/package/@dallay/agentsync)
6
+ [![license](https://img.shields.io/npm/l/@dallay/agentsync.svg)](./LICENSE)
7
+ [![repo](https://img.shields.io/badge/repo-dallay%2Fagentsync-blue)](https://github.com/dallay/agentsync)
8
+
9
+ Purpose
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.
12
+
13
+ Quick links
14
+ -----------
15
+ - Repository: https://github.com/dallay/agentsync
16
+ - Issues: https://github.com/dallay/agentsync/issues
17
+
18
+ Installation
19
+ ------------
20
+ Install locally with pnpm (recommended):
21
+
22
+ pnpm add @dallay/agentsync
23
+
24
+ Run without installing with pnpm dlx:
25
+
26
+ pnpm dlx @dallay/agentsync --help
27
+
28
+ Or with npx:
29
+
30
+ npx @dallay/agentsync --help
31
+
32
+ CLI Usage
33
+ ---------
34
+ The package exposes a CLI executable named `agentsync`.
35
+
36
+ Basic help:
37
+
38
+ agentsync --help
39
+
40
+ Common workflows:
41
+
42
+ - Create or update symlinks from a central config directory to target assistant config locations.
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
+ }
66
+ ```
67
+
68
+ Programmatic usage
69
+ -------------------
70
+ This package can be executed as a CLI. If you need to call core functionality from Node, require the package entry point and use the public functions exported from `lib/` (build artifacts). Generate typed API docs with TypeDoc if you want accurate signatures.
71
+
72
+ Example (run CLI programmatically):
73
+
74
+ ```js
75
+ // run the CLI handler as a programmatic entry point
76
+ const { main } = require('@dallay/agentsync');
77
+ main(process.argv).catch(err => {
78
+ console.error(err);
79
+ process.exit(1);
80
+ });
81
+ ```
82
+
83
+ Note: Replace the snippet above with the real exported function names if your code exposes a different API. Prefer inspecting `lib/index.js` or generating TypeDoc output to document precise signatures.
84
+
85
+ Development
86
+ -----------
87
+ Build and type-check (this project uses TypeScript):
88
+
89
+ pnpm install
90
+ pnpm run typecheck
91
+ pnpm run build
92
+
93
+ Useful scripts defined in package.json:
94
+
95
+ - typecheck — tsc --noEmit
96
+ - build — tsc
97
+ - clean — remove generated `lib/`
98
+
99
+ Publishing
100
+ ----------
101
+ This package is published to npm as @dallay/agentsync. The repository sets `publishConfig.access=public`.
102
+
103
+ Before publishing:
104
+
105
+ 1. Ensure `lib/` is built (pnpm run build).
106
+ 2. Verify package.json fields: `main`, `files`, `bin`, `repository`, `bugs`, `homepage`.
107
+ 3. Ensure LICENSE is present and tests/CI are green.
108
+
109
+ pnpm publish --access public
110
+
111
+ Contributing
112
+ ------------
113
+ Contributions welcome. Keep it simple:
114
+
115
+ 1. Fork the repo and create a feature branch.
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.
119
+
120
+ We use Conventional Commits to generate changelogs. Keep commits focused and small.
121
+
122
+ Security
123
+ --------
124
+ Report security issues by opening a private issue on the repository or emailing the maintainer listed in package.json.
125
+
126
+ License
127
+ -------
128
+ MIT — see LICENSE
129
+
130
+ More documentation
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.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@dallay/agentsync",
3
- "version": "1.8.2",
4
- "description": "Sync AI agent configurations across multiple AI coding assistants using symbolic links",
3
+ "version": "1.13.0",
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",
7
7
  "publishConfig": {
@@ -25,7 +25,9 @@
25
25
  "copilot",
26
26
  "gemini",
27
27
  "cursor",
28
- "opencode"
28
+ "opencode",
29
+ "mcp",
30
+ "mcp-server"
29
31
  ],
30
32
  "bin": {
31
33
  "agentsync": "lib/index.js"
@@ -35,16 +37,16 @@
35
37
  "lib"
36
38
  ],
37
39
  "devDependencies": {
38
- "@types/node": "^24.0.0",
40
+ "@types/node": "^24.1.0",
39
41
  "typescript": "^5.9.3"
40
42
  },
41
43
  "optionalDependencies": {
42
- "@dallay/agentsync-linux-x64": "1.8.2",
43
- "@dallay/agentsync-linux-arm64": "1.8.2",
44
- "@dallay/agentsync-darwin-x64": "1.8.2",
45
- "@dallay/agentsync-darwin-arm64": "1.8.2",
46
- "@dallay/agentsync-windows-x64": "1.8.2",
47
- "@dallay/agentsync-windows-arm64": "1.8.2"
44
+ "@dallay/agentsync-linux-x64": "1.13.0",
45
+ "@dallay/agentsync-linux-arm64": "1.13.0",
46
+ "@dallay/agentsync-darwin-x64": "1.13.0",
47
+ "@dallay/agentsync-darwin-arm64": "1.13.0",
48
+ "@dallay/agentsync-windows-x64": "1.13.0",
49
+ "@dallay/agentsync-windows-arm64": "1.13.0"
48
50
  },
49
51
  "engines": {
50
52
  "node": ">=18"