You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-15Lines changed: 34 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,18 +31,18 @@ CapSync solves this by creating a single source of truth for your skills and com
31
31
32
32
**What CapSync Is Not:**
33
33
34
-
- A skill or command discovery tool. CapSync does not find or download skills/commands from the internet
34
+
- A skill or command discovery tool. CapSync does not search registries or catalogs for skills/commands on your behalf
35
35
- A skill or command installer. You must already have skills/commands in your source directories
36
36
- A skill or command creator. CapSync only syncs what you already have
37
37
38
38
**Prerequisites:**
39
39
You need to have skills (and optionally commands) already installed in local directories before using CapSync. CapSync assumes you have:
40
40
41
-
- A directory containing your skills (e.g., `~/Dev/scripts/skills`)
42
-
- Optionally, a directory containing your commands (e.g., `~/Dev/scripts/commands`)
41
+
- A directory containing your skills (e.g., `~/dev/scripts/skills`)
42
+
- Optionally, a directory containing your commands (e.g., `~/dev/scripts/commands`)
43
43
- Skills and commands formatted for your AI tools
44
44
45
-
If you are looking for a tool to discover and install skills from a registry or repository, that is not what CapSync does. That may be a future feature, but for now, CapSync only syncs skills you already possess.
45
+
If you already know which Git repository you want, `capsync clone` can download it into your configured skills source. CapSync still does not browse, rank, or discover skills for you.
46
46
47
47
## Installation
48
48
@@ -99,7 +99,7 @@ cargo install --path .
99
99
100
100
Run `capsync init` to create your configuration. The tool will:
101
101
102
-
1. Ask for your skills directory path (supports `$HOME`, `~`, and other shell variables)
102
+
1. Ask for your skills source directory path (supports `$HOME`, `~`, and other shell variables)
103
103
2. Automatically detect if a `commands/` subdirectory exists in your skills directory
104
104
3. Prompt to enable commands if found
105
105
4. Scan your system for installed AI coding tools
@@ -110,7 +110,7 @@ Run `capsync init` to create your configuration. The tool will:
110
110
$ capsync init
111
111
Welcome to CapSync! Let's set up your configuration.
112
112
113
-
Enter your skills directory: $HOME/Dev/scripts/skills
113
+
Enter your skills source directory: $HOME/dev/scripts/skills
114
114
115
115
Detecting installed tools...
116
116
Detected and enabled: claude, opencode
@@ -124,9 +124,10 @@ If a `commands/` subdirectory is found in your skills directory:
124
124
$ capsync init
125
125
Welcome to CapSync! Let's set up your configuration.
126
126
127
-
Enter your skills directory: $HOME/Dev/scripts/skills
127
+
Enter your skills sourcedirectory: $HOME/dev/scripts/skills
128
128
129
-
Found commands/ subdirectory. Enable commands? [Y/n]: Y
129
+
Found commands/ subdirectory in skills source.
130
+
Enable commands? [Y/n]: Y
130
131
131
132
Detecting installed tools...
132
133
Detected and enabled: claude, opencode
@@ -190,7 +191,7 @@ CapSync uses directory symlinks (symbolic links) to connect your skills to each
190
191
191
192
### The Setup
192
193
193
-
1. You designate one directory as your skills source (e.g., `~/Dev/scripts/skills/skills`)
194
+
1. You designate one directory as your skills source (e.g., `~/dev/scripts/skills/skills`)
194
195
2. CapSync creates symlinks from that directory to each tool's expected skills location
195
196
3. Each tool sees your skills as if they were native to that tool
196
197
@@ -207,7 +208,7 @@ CapSync uses directory symlinks (symbolic links) to connect your skills to each
@@ -308,6 +309,24 @@ Scan system for installed AI coding tools without modifying config.
308
309
309
310
Create or update symlinks for all enabled tools.
310
311
312
+
### `capsync clone <repo>`
313
+
314
+
Clone a remote Git repository into your configured skills source.
315
+
316
+
Supported inputs:
317
+
318
+
-`owner/repo`
319
+
-`https://...`
320
+
-`http://...`
321
+
-`git@...`
322
+
323
+
Options:
324
+
325
+
-`--branch <name>`: Clone a specific branch instead of auto-detecting the remote default branch
326
+
-`--no-sync`: Skip running `capsync sync` after the clone finishes
327
+
328
+
If the skills source already exists, CapSync prompts before replacing it. During override, it offers a backup when local changes would otherwise be lost.
329
+
311
330
### `capsync add <tool>`
312
331
313
332
Add a tool to configuration and sync automatically.
0 commit comments