@mhmdreza-rafiei/agentry 0.2.1 → 0.3.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 CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 comprehensive-skills contributors
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.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 comprehensive-skills contributors
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 CHANGED
@@ -1,198 +1,280 @@
1
- <div align="center">
2
-
3
- # Agentry
4
-
5
- **Install agents, skills, rules, scripts, and profiles onto coding agents — from any Git repo.**
6
-
7
- Supports **Cursor**, **Claude Code**, **Codex**, **OpenCode**, and [70+ more](#supported-agents).
8
-
9
- [![npm](https://img.shields.io/npm/v/@mhmdreza-rafiei/agentry?style=flat&color=38bdf8)](https://www.npmjs.com/package/@mhmdreza-rafiei/agentry)
10
- [![node](https://img.shields.io/badge/node-%3E%3D22.20-38bdf8?style=flat)](#install)
11
- [![license](https://img.shields.io/badge/license-MIT-38bdf8?style=flat)](LICENSE)
12
- [![stars](https://img.shields.io/github/stars/mhmdreza-rafiei/agentry?style=social)](https://github.com/mhmdreza-rafiei/agentry)
13
-
14
- </div>
15
-
16
- ## Install
17
-
18
- ```bash
19
- npm install -g @mhmdreza-rafiei/agentry
20
- # or
21
- npx @mhmdreza-rafiei/agentry@latest --help
22
- ```
23
-
24
- ## Quick start
25
-
26
- ```bash
27
- # Browse + install skills from a repo
28
- agentry add skills mhmdreza-rafiei/agent-tools
29
-
30
- # Install one skill to Cursor
31
- agentry add skills mhmdreza-rafiei/agent-tools enhance-prompt -a cursor
32
-
33
- # See what is installed
34
- agentry list
35
- agentry list skills
36
- ```
37
-
38
- ## Commands
39
-
40
- | Command | Description |
41
- | --- | --- |
42
- | `agentry add <kind> <source> [selector]` | Discover and install artifacts |
43
- | `agentry add profile <name> [source]` | Apply a local `profile/<name>.yaml` bundle |
44
- | `agentry list` | List installed artifacts |
45
- | `agentry list <kind>` | List installed artifacts of one kind |
46
- | `agentry list <source> [kind] [selector]` | List what a repo/path contains |
47
- | `agentry remove <kind> [source] [selector]` | Remove installs (files + lock) |
48
- | `agentry update [kind] [source] [selector]` | Re-install from source or lockfile |
49
- | `agentry init <kind> [name] [category]` | Scaffold a new artifact |
50
- | `agentry update` | Update the Agentry CLI itself |
51
- | `agentry uninstall` | Uninstall the Agentry CLI |
52
-
53
- `<kind>` is `skill | rule | agent | profile | script` (plurals accepted).
54
-
55
- ### Source formats
56
-
57
- ```bash
58
- # GitHub shorthand
59
- agentry add skills mhmdreza-rafiei/agent-tools
60
-
61
- # Full GitHub URL
62
- agentry add skills https://github.com/mhmdreza-rafiei/agent-tools
63
-
64
- # Tree URL (subdir + ref)
65
- agentry add skills https://github.com/mhmdreza-rafiei/agent-tools/tree/main/skills
66
-
67
- # Local path
68
- agentry add skills ./my-skills
69
-
70
- # Any git URL
71
- agentry add skills git@github.com:mhmdreza-rafiei/agent-tools.git
72
- ```
73
-
74
- ### Options
75
-
76
- | Option | Description |
77
- | --- | --- |
78
- | `-g, --global` | Install into `~` (all projects) |
79
- | `--project` | Install into the current folder (default) |
80
- | `--dir <path>` | Install into a specific folder |
81
- | `-a, --agent <name>` | Target provider(s); repeatable; `*` = all |
82
- | `-l, --list` | Preview only — write nothing |
83
- | `--copy` | Copy instead of symlink for non-universal agents |
84
- | `--all` | Install everything to all agents, no prompts |
85
- | `-y, --yes` | Skip prompts |
86
- | `--description <text>` | `init`: frontmatter description |
87
- | `--alwaysApply` | `init` rule: `alwaysApply: true` |
88
- | `--reference` / `--no-reference` | `init` skill: include `references/TEMPLATE.md` |
89
- | `--skills` / `--agents` / `--rules` / `--scripts` `[src]` | `init` profile: include kinds (optional source) |
90
-
91
- ## Examples
92
-
93
- ```bash
94
- # List everything in a catalog repo
95
- agentry list mhmdreza-rafiei/agent-tools
96
- agentry list mhmdreza-rafiei/agent-tools skills
97
- agentry list mhmdreza-rafiei/agent-tools skills enhance-prompt
98
-
99
- # Install
100
- agentry add skills mhmdreza-rafiei/agent-tools
101
- agentry add skills mhmdreza-rafiei/agent-tools enhance-prompt -a cursor -a claude-code
102
- agentry add rules mhmdreza-rafiei/agent-tools ask-dont-guess
103
- agentry add agents mhmdreza-rafiei/agent-tools frontend-developer
104
-
105
- # Inventory
106
- agentry list
107
- agentry list skills
108
-
109
- # Update / remove by selector or by install source
110
- agentry update skills mhmdreza-rafiei/agent-tools
111
- agentry remove skills enhance-prompt
112
- agentry remove skills mhmdreza-rafiei/agent-tools
113
-
114
- # Scaffold
115
- agentry init skill enhance-prompt prompt --reference
116
- agentry init rule ask-dont-guess --alwaysApply --description "Ask before guessing"
117
- agentry init profile frontend --skills mhmdreza-rafiei/agent-tools -a cursor
118
- ```
119
-
120
- Example catalog used throughout this README: [`mhmdreza-rafiei/agent-tools`](https://github.com/mhmdreza-rafiei/agent-tools).
121
-
122
- ## How it works
123
-
124
- 1. Resolve a source (local path or shallow git clone).
125
- 2. Discover artifacts under `<kind>s/` **and** root markers (`SKILL.md`, `.mdc`).
126
- 3. Let you pick what to install (searchable list + `All`).
127
- 4. Install once to `.agents/skills/<id>` for universal providers; symlink (or `--copy`) for others.
128
- 5. Track installs in `.agentry/lock.json` for remove/update.
129
-
130
- If a clone fails and a prior cache exists, Agentry asks whether to load from cache (`~/.cache/agentry/repos`).
131
-
132
- ## Artifact layouts
133
-
134
- Author installable tools in a source repo like this:
135
-
136
- ### Skills
137
-
138
- ```text
139
- skills/
140
- enhance-prompt/
141
- SKILL.md
142
- references/
143
- TEMPLATE.md
144
- prompt/
145
- rewrite/
146
- SKILL.md
147
- ```
148
-
149
- ### Agents / rules
150
-
151
- ```text
152
- agents/
153
- frontend-developer.mdc
154
- rules/
155
- ask-dont-guess.mdc
156
- ```
157
-
158
- ### Scripts / profiles
159
-
160
- ```text
161
- scripts/
162
- deploy/
163
- README.md
164
- profiles/
165
- frontend.yaml
166
- ```
167
-
168
- Local install profiles (consumed by `agentry add profile`) live at `profile/<name>.yaml`.
169
-
170
- ## Supported agents
171
-
172
- Agentry targets **70+** providers. Universal providers share `.agents/skills/`; others get a symlink or copy.
173
-
174
- | Agent | Skills path |
175
- | --- | --- |
176
- | Cursor | `.agents/skills` |
177
- | Codex | `.agents/skills` |
178
- | OpenCode | `.agents/skills` |
179
- | Gemini CLI | `.agents/skills` |
180
- | Claude Code | `.claude/skills` |
181
- | Windsurf | `.windsurf/skills` |
182
- | … | see `src/registry/agents.ts` |
183
-
184
- ## Development
185
-
186
- ```bash
187
- npm install
188
- npm run typecheck
189
- npm test
190
- npm run build
191
- node dist/cli.mjs --help
192
- ```
193
-
194
- Requires **Node ≥ 22.20**.
195
-
196
- ## License
197
-
198
- [MIT](LICENSE)
1
+ <div align="center">
2
+
3
+ # Agentry
4
+
5
+ **Install agents, skills, rules, scripts, and profiles onto coding agents — from any Git repo.**
6
+
7
+ Supports **Cursor**, **Claude Code**, **Codex**, **OpenCode**, and [70+ more](#supported-agents).
8
+
9
+ [![npm](https://img.shields.io/npm/v/@mhmdreza-rafiei/agentry?style=flat&color=38bdf8)](https://www.npmjs.com/package/@mhmdreza-rafiei/agentry)
10
+ [![node](https://img.shields.io/badge/node-%3E%3D22.20-38bdf8?style=flat)](#install)
11
+ [![license](https://img.shields.io/badge/license-MIT-38bdf8?style=flat)](LICENSE)
12
+ [![stars](https://img.shields.io/github/stars/mhmdreza-rafiei/agentry?style=social)](https://github.com/mhmdreza-rafiei/agentry)
13
+
14
+ </div>
15
+
16
+ ## Install
17
+
18
+ ```bash
19
+ npm install -g @mhmdreza-rafiei/agentry
20
+ # or
21
+ npx @mhmdreza-rafiei/agentry@latest --help
22
+ ```
23
+
24
+ ## Quick start
25
+
26
+ ```bash
27
+ # Install a standalone single-skill repository (root SKILL.md)
28
+ agentry add author/my-skill
29
+
30
+ # Browse + install from a catalog repo (kind is optional or explicit)
31
+ agentry add mhmdreza-rafiei/agent-tools
32
+ agentry add skills mhmdreza-rafiei/agent-tools
33
+
34
+ # Install one skill to Cursor
35
+ agentry add mhmdreza-rafiei/agent-tools enhance-prompt -a cursor
36
+
37
+ # See what is installed
38
+ agentry list
39
+ agentry list skills
40
+ ```
41
+
42
+ ## What it looks like
43
+
44
+ ```text
45
+ █████╗ ██████╗ ███████╗███╗ ██╗████████╗██████╗ ██╗ ██╗
46
+ ██╔══██╗██╔════╝ ██╔════╝████╗ ██║╚══██╔══╝██╔══██╗╚██╗ ██╔╝
47
+ ███████║██║ ███╗█████╗ ██╔██╗ ██║ ██║ ██████╔╝ ╚████╔╝
48
+ ██╔══██║██║ ██║██╔══╝ ██║╚██╗██║ ██║ ██╔══██╗ ╚██╔╝
49
+ ██║ ██║╚██████╔╝███████╗██║ ╚████║ ██║ ██║ ██║ ██║
50
+ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝
51
+ Install agents, skills, rules & profiles
52
+
53
+ ◇ Cloning mhmdreza-rafiei/agent-tools
54
+ ◇ Found 12 skills
55
+
56
+ ◆ Select skills to install
57
+ │ Search: enhance
58
+ │ ◼ All
59
+ │ ◼ prompt/enhance-prompt
60
+ │ ◻ quick-start
61
+ │
62
+ ◇ Which agents do you want to install to?
63
+ │ Universal (.agents/skills) · Cursor, Codex, …
64
+ │ ◼ Claude Code
65
+
66
+ ◆ Installation scope
67
+ │
68
+ │ ● Project
69
+ │ Install in the current directory (committed with your project)
70
+ │ → /path/to/your-project
71
+ │ lock /path/to/your-project/.agentry/lock.json
72
+ │
73
+ │ ○ Global
74
+ │ Install in your home directory (available across all projects)
75
+ │ → /home/you
76
+ │ lock /home/you/.agentry/lock.json
77
+ └ ↑/↓ select · enter confirm
78
+
79
+ ◆ Install summary
80
+ │ Scope project
81
+ │ Targets 4 agents · 3 universal · 1 additional
82
+ │ Cursor, Codex, OpenCode, Claude Code
83
+ │
84
+ │ Artifacts 1 selected
85
+ │ • skill/prompt/enhance-prompt
86
+ │ Rewrite prompts for clarity and fidelity
87
+ │
88
+ └ Review before use — artifacts run with full agent permissions.
89
+
90
+ ◇ Installed skill/prompt/enhance-prompt
91
+ ```
92
+
93
+ ## Commands
94
+
95
+ | Command | Description |
96
+ | --- | --- |
97
+ | `agentry add [kind] <source> [selector]` | Discover and install artifacts (kind is optional) |
98
+ | `agentry add profile <name> [source]` | Apply a local `profile/<name>.yaml` bundle |
99
+ | `agentry list` | List installed artifacts |
100
+ | `agentry list <kind>` | List installed artifacts of one kind |
101
+ | `agentry list <source> [kind] [selector]` | List what a repo/path contains |
102
+ | `agentry remove [kind] [source] [selector]` | Remove installs (files + lock) |
103
+ | `agentry update [kind] [source] [selector]` | Re-install from source or lockfile |
104
+ | `agentry init <kind> [name] [category]` | Scaffold a new artifact |
105
+ | `agentry update` | Update the Agentry CLI itself |
106
+ | `agentry uninstall` | Uninstall the Agentry CLI |
107
+
108
+ `<kind>` is `skill | rule | agent | profile | script` (plurals accepted; omit to match all).
109
+
110
+ ### Source formats
111
+
112
+ ```bash
113
+ # GitHub shorthand (single-skill repo or catalog)
114
+ agentry add mhmdreza-rafiei/agent-tools
115
+ agentry add skills mhmdreza-rafiei/agent-tools
116
+
117
+ # Full GitHub URL
118
+ agentry add https://github.com/mhmdreza-rafiei/agent-tools
119
+
120
+ # Tree URL (subdir + ref)
121
+ agentry add https://github.com/mhmdreza-rafiei/agent-tools/tree/main/skills
122
+
123
+ # Local path
124
+ agentry add ./my-skills
125
+
126
+ # Any git URL
127
+ agentry add git@github.com:mhmdreza-rafiei/agent-tools.git
128
+ ```
129
+
130
+ ### Options
131
+
132
+ | Option | Description |
133
+ | --- | --- |
134
+ | `-g, --global` | Install into `~` (all projects) |
135
+ | `-p, --project` | Install into the current folder |
136
+ | `-d, --dir <path>` | Install into a specific folder |
137
+ | `-a, --agent <name>` | Target provider(s); repeatable; `*` = all |
138
+ | `-l, --list` | Preview only — write nothing |
139
+ | `--copy` | Copy instead of symlink for non-universal agents |
140
+ | `--all` | Install everything to all agents, no prompts |
141
+ | `-y, --yes` | Skip prompts (scope defaults to project) |
142
+ | `--description <text>` | `init`: frontmatter description |
143
+ | `--alwaysApply` | `init` rule: `alwaysApply: true` |
144
+ | `--reference` / `--no-reference` | `init` skill: include `references/TEMPLATE.md` |
145
+ | `--skills` / `--agents` / `--rules` / `--scripts` `[src]` | `init` profile: include kinds (optional source) |
146
+
147
+ ## Examples
148
+
149
+ ```bash
150
+ # List everything in a catalog repo
151
+ agentry list mhmdreza-rafiei/agent-tools
152
+ agentry list mhmdreza-rafiei/agent-tools skills
153
+ agentry list mhmdreza-rafiei/agent-tools enhance-prompt
154
+
155
+ # Install
156
+ agentry add mhmdreza-rafiei/agent-tools
157
+ agentry add skills mhmdreza-rafiei/agent-tools enhance-prompt -a cursor -a claude-code
158
+ agentry add rules mhmdreza-rafiei/agent-tools ask-dont-guess
159
+ agentry add agents mhmdreza-rafiei/agent-tools frontend-developer
160
+
161
+ # Inventory
162
+ agentry list
163
+ agentry list skills
164
+
165
+ # Update / remove by selector or by install source
166
+ agentry update skills mhmdreza-rafiei/agent-tools
167
+ agentry remove enhance-prompt
168
+ agentry remove skills mhmdreza-rafiei/agent-tools
169
+
170
+ # Scaffold
171
+ agentry init skill enhance-prompt prompt --reference
172
+ agentry init rule ask-dont-guess --alwaysApply --description "Ask before guessing"
173
+ agentry init profile frontend --skills mhmdreza-rafiei/agent-tools -a cursor
174
+ ```
175
+
176
+ Example catalog used throughout this README: [`mhmdreza-rafiei/agent-tools`](https://github.com/mhmdreza-rafiei/agent-tools).
177
+
178
+ ## How it works
179
+
180
+ 1. Resolve a source (local path or shallow git clone).
181
+ 2. Discover artifacts under `<kind>s/` **and** root markers:
182
+ - Root `SKILL.md` (standalone single-skill repo)
183
+ - Root `AGENT.md` / `RULE.md` / `.cursorrules` / `.mdc` files
184
+ - Root `profile/<name>.yaml` / `*.profile.yaml` / `profile.yaml`
185
+ - Root scripts (`run.sh`, `script.sh`, `run.js`)
186
+ 3. Filter out directories/files ignored by `.agentryignore` or `.agentry.ignore` (and built-in VCS ignores like `.git`).
187
+ 4. Let you pick what to install (searchable list + `All`).
188
+ 5. Install once to `.agents/skills/<id>` for universal providers; symlink (or `--copy`) for others.
189
+ 6. Track installs in `.agentry/lock.json` for remove/update.
190
+
191
+ If a clone fails and a prior cache exists, Agentry asks whether to load from cache (`~/.cache/agentry/repos`).
192
+
193
+ ## Artifact layouts
194
+
195
+ Author installable tools in a source repo:
196
+
197
+ ### Single-skill repo (Root layout)
198
+
199
+ ```text
200
+ SKILL.md
201
+ references/
202
+ GUIDE.md
203
+ scripts/
204
+ tool.sh
205
+ ```
206
+
207
+ ### Multi-skill catalog
208
+
209
+ ```text
210
+ skills/
211
+ enhance-prompt/
212
+ SKILL.md
213
+ references/
214
+ TEMPLATE.md
215
+ prompt/
216
+ rewrite/
217
+ SKILL.md
218
+ ```
219
+
220
+ ### Agents / rules
221
+
222
+ ```text
223
+ agents/
224
+ frontend-developer.mdc
225
+ rules/
226
+ ask-dont-guess.mdc
227
+ ```
228
+
229
+ ### Scripts / profiles
230
+
231
+ ```text
232
+ scripts/
233
+ deploy/
234
+ README.md
235
+ profiles/
236
+ frontend.yaml
237
+ ```
238
+
239
+ Local install profiles live at `profile/<name>.yaml`.
240
+
241
+ ### Excluding development assets (`.agentryignore`)
242
+
243
+ Place `.agentryignore` (or `.agentry.ignore`) in the root of your repo to prevent internal tools from being discovered or installed:
244
+
245
+ ```gitignore
246
+ # Exclude internal dev skills
247
+ dev-skills/
248
+ skills/internal-*
249
+ *.draft.mdc
250
+ ```
251
+
252
+ ## Supported agents
253
+
254
+ Agentry targets **70+** providers. Universal providers share `.agents/skills/`; others get a symlink or copy.
255
+
256
+ | Agent | Skills path |
257
+ | --- | --- |
258
+ | Cursor | `.agents/skills` |
259
+ | Codex | `.agents/skills` |
260
+ | OpenCode | `.agents/skills` |
261
+ | Gemini CLI | `.agents/skills` |
262
+ | Claude Code | `.claude/skills` |
263
+ | Windsurf | `.windsurf/skills` |
264
+ | … | see `src/registry/agents.ts` |
265
+
266
+ ## Development
267
+
268
+ ```bash
269
+ npm install
270
+ npm run typecheck
271
+ npm test
272
+ npm run build
273
+ node dist/cli.mjs --help
274
+ ```
275
+
276
+ Requires **Node ≥ 22.20**.
277
+
278
+ ## License
279
+
280
+ [MIT](LICENSE)
@@ -122,13 +122,13 @@ function printHelp() {
122
122
  "",
123
123
  h("Options"),
124
124
  ` ${flag("-g, --global")} ${dim("Install into ~ (all projects)")}`,
125
- ` ${flag("--project")} ${dim("Install into the current folder (default)")}`,
126
- ` ${flag("--dir")} ${dim("<p>")} ${dim("Install into a specific folder")}`,
125
+ ` ${flag("-p, --project")} ${dim("Install into the current folder")}`,
126
+ ` ${flag("-d, --dir")} ${dim("<p>")} ${dim("Install into a specific folder")}`,
127
127
  ` ${flag("-a, --agent")} ${dim("<n>")} ${dim("Target provider(s); repeatable; '*' = all")}`,
128
128
  ` ${flag("-l, --list")} ${dim("Preview only — write nothing")}`,
129
129
  ` ${flag("--copy")} ${dim("Copy files instead of symlinking")}`,
130
130
  ` ${flag("--all")} ${dim("Install everything to all agents, no prompts")}`,
131
- ` ${flag("-y, --yes")} ${dim("Don't prompt")}`,
131
+ ` ${flag("-y, --yes")} ${dim("Don't prompt (scope defaults to project)")}`,
132
132
  ` ${flag("--description")} ${dim("<t>")} ${dim("init: frontmatter description")}`,
133
133
  ` ${flag("--alwaysApply")} ${dim("init rule: alwaysApply: true")}`,
134
134
  ` ${flag("--reference")} ${dim("init skill: add references/TEMPLATE.md")}`,