@synapsync/cli 0.1.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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 SynapSync
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.
package/README.md ADDED
@@ -0,0 +1,298 @@
1
+ ```text
2
+ ███████╗██╗ ██╗███╗ ██╗ █████╗ ██████╗ ███████╗██╗ ██╗███╗ ██╗ ██████╗
3
+ ██╔════╝╚██╗ ██╔╝████╗ ██║██╔══██╗██╔══██╗██╔════╝╚██╗ ██╔╝████╗ ██║██╔════╝
4
+ ███████╗ ╚████╔╝ ██╔██╗ ██║███████║██████╔╝███████╗ ╚████╔╝ ██╔██╗ ██║██║
5
+ ╚════██║ ╚██╔╝ ██║╚██╗██║██╔══██║██╔═══╝ ╚════██║ ╚██╔╝ ██║╚██╗██║██║
6
+ ███████║ ██║ ██║ ╚████║██║ ██║██║ ███████║ ██║ ██║ ╚████║╚██████╗
7
+ ╚══════╝ ╚═╝ ╚═╝ ╚═══╝╚═╝ ╚═╝╚═╝ ╚══════╝ ╚═╝ ╚═╝ ╚═══╝ ╚═════╝
8
+ ```
9
+
10
+ # SynapSync CLI
11
+
12
+ Neural AI Orchestration Platform - Manage AI cognitives (skills, agents, prompts, tools) across multiple providers.
13
+
14
+ [![Node.js](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org/)
15
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
16
+
17
+ ## Overview
18
+
19
+ SynapSync CLI allows you to manage and synchronize AI cognitives across different AI providers (Claude, OpenAI, Cursor, etc.). Define your skills, agents, and prompts once, and sync them to all your AI tools.
20
+
21
+ ### Key Features
22
+
23
+ - **Multi-Provider Support**: Sync cognitives to Claude, OpenAI, Cursor, and more
24
+ - **Cognitive Types**: Manage skills, agents, prompts, workflows, and tools
25
+ - **Registry Integration**: Search and install cognitives from the public registry
26
+ - **Symlink-Based Sync**: Efficient synchronization using symlinks (with copy fallback)
27
+ - **GitHub Integration**: Install cognitives directly from GitHub repositories
28
+
29
+ ## Installation
30
+
31
+ ```bash
32
+ # Install globally
33
+ npm install -g synapsync
34
+
35
+ # Or use npx
36
+ npx synapsync
37
+ ```
38
+
39
+ ### Requirements
40
+
41
+ - Node.js >= 20.0.0
42
+ - npm or yarn
43
+
44
+ ## Quick Start
45
+
46
+ ```bash
47
+ # Initialize a new project
48
+ synapsync init
49
+
50
+ # Search for cognitives
51
+ synapsync search code review
52
+
53
+ # Install a cognitive
54
+ synapsync install code-reviewer
55
+
56
+ # List installed cognitives
57
+ synapsync list
58
+
59
+ # Sync to providers
60
+ synapsync sync
61
+ ```
62
+
63
+ ## Commands
64
+
65
+ ### Project Setup
66
+
67
+ | Command | Description |
68
+ | ------------------------------------ | ---------------------------------- |
69
+ | `synapsync init` | Initialize a new SynapSync project |
70
+ | `synapsync status` | Show project status |
71
+ | `synapsync config list` | List all configuration |
72
+ | `synapsync config get <key>` | Get a configuration value |
73
+ | `synapsync config set <key> <value>` | Set a configuration value |
74
+
75
+ ### Provider Management
76
+
77
+ | Command | Description |
78
+ | -------------------------------------------- | ----------------------------------- |
79
+ | `synapsync providers` | List all providers and their status |
80
+ | `synapsync providers enable <provider>` | Enable a provider |
81
+ | `synapsync providers disable <provider>` | Disable a provider |
82
+ | `synapsync providers path <provider> <path>` | Set custom path for a provider |
83
+
84
+ ### Cognitive Management
85
+
86
+ | Command | Description |
87
+ | ------------------------------ | ------------------------------------- |
88
+ | `synapsync search [query]` | Search for cognitives in the registry |
89
+ | `synapsync install <source>` | Install a cognitive |
90
+ | `synapsync list` | List installed cognitives |
91
+ | `synapsync uninstall <name>` | Uninstall a cognitive |
92
+ | `synapsync update [cognitive]` | Update cognitives to latest versions |
93
+ | `synapsync update --all` | Update all cognitives |
94
+
95
+ ### Synchronization
96
+
97
+ | Command | Description |
98
+ | ---------------------------------- | ------------------------------------------- |
99
+ | `synapsync sync` | Sync cognitives with manifest and providers |
100
+ | `synapsync sync --dry-run` | Preview sync without applying changes |
101
+ | `synapsync sync --provider <name>` | Sync only to a specific provider |
102
+ | `synapsync sync status` | Show current sync status |
103
+
104
+ ### Maintenance
105
+
106
+ | Command | Description |
107
+ | ------------------------ | ------------------------------ |
108
+ | `synapsync doctor` | Diagnose project issues |
109
+ | `synapsync doctor --fix` | Auto-fix detected issues |
110
+ | `synapsync clean` | Clean cache and orphaned files |
111
+ | `synapsync clean --all` | Clean everything |
112
+
113
+ ### Information
114
+
115
+ | Command | Description |
116
+ | ----------------------------- | -------------------------------- |
117
+ | `synapsync help [command]` | Display help for a command |
118
+ | `synapsync version` | Show version information |
119
+ | `synapsync version --check` | Check for updates |
120
+ | `synapsync info` | Show SynapSync concepts |
121
+ | `synapsync info --cognitives` | Learn about cognitive types |
122
+ | `synapsync info --install` | Learn about installation sources |
123
+ | `synapsync info --providers` | Learn about supported providers |
124
+
125
+ ## Installation Sources
126
+
127
+ SynapSync supports multiple installation sources:
128
+
129
+ ```bash
130
+ # From registry
131
+ synapsync install code-reviewer
132
+
133
+ # From local path
134
+ synapsync install ./my-cognitive
135
+
136
+ # From GitHub (shorthand)
137
+ synapsync install github:user/repo
138
+
139
+ # From GitHub with path
140
+ synapsync install github:user/repo/cognitives/skill
141
+
142
+ # From GitHub with branch
143
+ synapsync install github:user/repo#develop
144
+
145
+ # From GitHub URL
146
+ synapsync install https://github.com/user/repo
147
+ ```
148
+
149
+ ## Cognitive Types
150
+
151
+ | Type | File | Description |
152
+ | ---------- | --------------- | ------------------------------------------ |
153
+ | `skill` | `SKILL.md` | Reusable capabilities for specific tasks |
154
+ | `agent` | `AGENT.md` | Autonomous entities with defined behaviors |
155
+ | `prompt` | `PROMPT.md` | Template prompts for common scenarios |
156
+ | `workflow` | `WORKFLOW.yaml` | Multi-step orchestrated processes |
157
+ | `tool` | `TOOL.md` | External integrations and utilities |
158
+
159
+ ## Project Structure
160
+
161
+ After running `synapsync init`, your project will have:
162
+
163
+ ```
164
+ your-project/
165
+ ├── .synapsync/
166
+ │ ├── skills/
167
+ │ │ └── {category}/
168
+ │ │ └── {name}/
169
+ │ │ └── SKILL.md
170
+ │ ├── agents/
171
+ │ ├── prompts/
172
+ │ ├── workflows/
173
+ │ ├── tools/
174
+ │ ├── cache/
175
+ │ └── manifest.json
176
+ ├── synapsync.config.yaml
177
+ └── .gitignore (updated)
178
+ ```
179
+
180
+ ## Supported Providers
181
+
182
+ | Provider | Status | Sync Path |
183
+ | -------- | ------------ | ------------------- |
184
+ | Claude | ✅ Supported | `.claude/commands/` |
185
+ | Cursor | ✅ Supported | `.cursor/` |
186
+ | OpenAI | ✅ Supported | `.openai/` |
187
+ | Gemini | 🔜 Planned | `.gemini/` |
188
+ | Copilot | 🔜 Planned | `.github/copilot/` |
189
+
190
+ ## Configuration
191
+
192
+ Configuration is stored in `synapsync.config.yaml`:
193
+
194
+ ```yaml
195
+ version: '1.0.0'
196
+
197
+ project:
198
+ name: my-project
199
+ description: My AI-enhanced project
200
+
201
+ providers:
202
+ claude:
203
+ enabled: true
204
+ path: .claude/commands
205
+ cursor:
206
+ enabled: false
207
+ path: .cursor
208
+ openai:
209
+ enabled: false
210
+ path: .openai
211
+
212
+ storage:
213
+ cognitivesDir: .synapsync
214
+ cacheDir: .synapsync/cache
215
+ ```
216
+
217
+ ## Troubleshooting
218
+
219
+ ### Common Issues
220
+
221
+ **Project not initialized**
222
+
223
+ ```bash
224
+ # Error: No SynapSync project found
225
+ synapsync init
226
+ ```
227
+
228
+ **Symlinks not working (Windows)**
229
+
230
+ ```bash
231
+ # Use copy mode instead
232
+ synapsync sync --copy
233
+ ```
234
+
235
+ **Broken symlinks after moving cognitives**
236
+
237
+ ```bash
238
+ # Clean orphaned symlinks and re-sync
239
+ synapsync clean --orphans
240
+ synapsync sync
241
+ ```
242
+
243
+ **Registry connection issues**
244
+
245
+ ```bash
246
+ # Check connectivity
247
+ synapsync doctor
248
+
249
+ # Clear cache and retry
250
+ synapsync clean --cache
251
+ ```
252
+
253
+ ### Diagnostic Commands
254
+
255
+ ```bash
256
+ # Run full diagnostics
257
+ synapsync doctor
258
+
259
+ # Auto-fix issues
260
+ synapsync doctor --fix
261
+
262
+ # Verbose output for debugging
263
+ synapsync --verbose <command>
264
+ ```
265
+
266
+ ## Development
267
+
268
+ ```bash
269
+ # Clone the repository
270
+ git clone https://github.com/synapsync/cli.git
271
+ cd cli
272
+
273
+ # Install dependencies
274
+ npm install
275
+
276
+ # Build
277
+ npm run build
278
+
279
+ # Run in development mode
280
+ npm run dev
281
+
282
+ # Run tests
283
+ npm test
284
+
285
+ # Lint
286
+ npm run lint
287
+ ```
288
+
289
+ ## License
290
+
291
+ MIT License - see [LICENSE](LICENSE) for details.
292
+
293
+ ## Links
294
+
295
+ - [Documentation](https://docs.synapsync.dev)
296
+ - [Registry](https://registry.synapsync.dev)
297
+ - [GitHub](https://github.com/synapsync/cli)
298
+ - [Issues](https://github.com/synapsync/cli/issues)
@@ -0,0 +1,2 @@
1
+
2
+ export { }