@aipm-registry/cli 0.2.12 → 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.
Files changed (4) hide show
  1. package/README.md +89 -44
  2. package/dist/bin.cjs +406 -77
  3. package/dist/bin.cjs.map +4 -4
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -1,7 +1,25 @@
1
+ # Search the registry at [aipm-registry.com](https://aipm-registry.com) for a skill
2
+
3
+
1
4
  # AIPM CLI
2
5
 
3
- AIPM installs project-ready AI skills into supported tools such as Cursor and
4
- Claude.
6
+ **An Open source command-line tool for AI skills management and discovery [AIPM](https://aipm-registry.com)**
7
+
8
+ ## What is this?
9
+
10
+ AI coding tools like Cursor and Claude can follow **skills**: small instruction files that teach the assistant how to do a job (code review, release notes, issue summaries, and more).
11
+
12
+ AIPM makes skills easy to **find, install, and share** — like npm, but for AI skills.
13
+
14
+ This package gives you the `aipm` command. With it you can:
15
+
16
+ - **Browse and install** skills from the public registry at **[aipm-registry.com](https://aipm-registry.com)**
17
+ - **Add skills to your project** so your whole team uses the same instructions
18
+ - **Publish your own skills** so others can install them
19
+
20
+ No other AIPM packages are required — everything is bundled in one install.
21
+
22
+ **Supported tools today:** Cursor and Claude (more targets at [aipm-registry.com/targets](https://aipm-registry.com/targets)).
5
23
 
6
24
  ## Install
7
25
 
@@ -9,37 +27,46 @@ Claude.
9
27
  npm install -g @aipm-registry/cli
10
28
  aipm --version
11
29
  aipm doctor
12
- aipm config
13
30
  ```
14
31
 
15
- ## Use
32
+ `aipm doctor` checks that your setup is ready. Run it if something does not work.
33
+
34
+ ## Install skills in your project
16
35
 
17
- Initialize a project:
36
+ Start in any project folder:
18
37
 
19
38
  ```bash
20
- aipm init
39
+ aipm init --target cursor
21
40
  ```
22
41
 
23
- Install a skill from the public registry:
42
+ *Search the registry at [aipm-registry.com](https://aipm-registry.com) for a skill:*
24
43
 
25
44
  ```bash
26
- aipm add @scope/name@1.0.0 --target cursor --ci
45
+ aipm search sentry
27
46
  ```
28
47
 
29
- List installed skills:
48
+ Results show version, supported tools, description, publisher, license, and size.
49
+
50
+ For private organization packages, sign in once from the CLI:
30
51
 
31
52
  ```bash
32
- aipm list
53
+ aipm login
54
+ aipm whoami
33
55
  ```
34
56
 
35
- Search the registry:
57
+ After login, `aipm add`, `aipm install`, `aipm update`, and `aipm search` automatically use your account access. Use `--token` or `AIPM_TOKEN` only for CI or bot installs.
58
+
59
+ Install a skill:
36
60
 
37
61
  ```bash
38
- aipm search sentry
62
+ aipm add @scope/name@1.0.0 --target cursor
39
63
  ```
40
64
 
41
- Search results include package version, supported targets, description,
42
- publisher identity when available, license, and package size.
65
+ See what is installed:
66
+
67
+ ```bash
68
+ aipm list
69
+ ```
43
70
 
44
71
  Update installed skills:
45
72
 
@@ -47,53 +74,71 @@ Update installed skills:
47
74
  aipm update
48
75
  ```
49
76
 
50
- This package is bundled. Installing `@aipm-registry/cli` gives you the `aipm`
51
- command without needing to install any other AIPM npm packages manually.
77
+ Browse more packages on the website: **[aipm-registry.com](https://aipm-registry.com)**
78
+
79
+ ## Publish your skill (public / private / organization-only)
52
80
 
53
- Publish a public skill:
81
+ Share a skill with your team or the public registry.
82
+
83
+ 1. Create a free account at **[aipm-registry.com](https://aipm-registry.com)**
84
+ 2. Create an org and reserve your package name (for example `@team/review-helper`)
85
+ 3. Scaffold a new skill package:
54
86
 
55
87
  ```bash
56
88
  aipm publish init --name @team/review-helper --template code-review
57
89
  cd review-helper
58
- aipm publish explain # (optional)
90
+ ```
91
+
92
+ 1. Add your files and push:
93
+
94
+ ```bash
59
95
  aipm publish add .
60
- aipm publish status # (optional)
61
- aipm publish preview # (optional)
62
- aipm publish validate # (optional)
63
- aipm publish token --package @team/review-helper # (optional)
96
+ aipm publish preview # optional — see what will be uploaded
97
+ aipm publish validate # optional — check for problems
64
98
  AIPM_TOKEN=<5-minute-token> aipm publish push --yes
65
99
  ```
66
100
 
67
- Create an account on `https://aipm-registry.com`, create an org, reserve the
68
- package name, and generate the 5-minute token from the package dashboard.
101
+ Get the short-lived publish token from your package page on **[aipm-registry.com/dashboard](https://aipm-registry.com/dashboard)**.
69
102
 
70
- Use `.aipmignore` to exclude local-only files from publishing. AIPM also
71
- rejects common private key, env, Azure connection string, publish profile, and
72
- large package mistakes before upload.
103
+ **Starter templates:** `blank`, `code-review`, `issue-summary`, `release-notes`. They only set the initial `SKILL.md` — edit any file before publishing.
104
+
105
+ **Already have a skill file?** Import it into an AIPM package:
106
+
107
+ ```bash
108
+ aipm publish import ~/.codex/skills/review-helper --name @team/review-helper
109
+ cd review-helper
110
+ aipm publish add .
111
+ ```
73
112
 
74
- Helpful publishing commands:
113
+ **Helpful extras:**
75
114
 
76
115
  ```bash
77
- aipm publish init --name @team/issue-summary --template issue-summary
78
- aipm publish init --name @team/release-notes --template release-notes
79
- aipm publish open --docs # (optional)
80
- aipm publish open --package @team/review-helper # (optional)
81
- aipm doctor --publish # (optional)
116
+ aipm publish explain # what publishing does
117
+ aipm publish status # staged files
118
+ aipm publish token --package @team/review-helper
119
+ aipm publish open --docs # open publishing docs
120
+ aipm publish open --package @team/review-helper
121
+ aipm doctor --publish # check publish setup
82
122
  ```
83
123
 
84
- Starter templates are `blank`, `code-review`, `issue-summary`, and
85
- `release-notes`. They only change the starter `SKILL.md`; you can edit every
86
- file before staging and publishing.
124
+ Use `.aipmignore` to skip local-only files. Before upload, AIPM blocks common mistakes such as private keys, `.env` files, and oversized packages.
125
+
126
+ Full publishing guide: **[aipm-registry.com/publish](https://aipm-registry.com/publish)**
87
127
 
88
- If your AI tool already generated a skill or rule file, import it into an AIPM package folder:
128
+ ## Configuration
89
129
 
90
130
  ```bash
91
- aipm publish import ~/.codex/skills/review-helper --name @team/review-helper
92
- cd review-helper
93
- aipm publish add .
94
- aipm publish preview # (optional)
131
+ aipm config
132
+ aipm logout
95
133
  ```
96
134
 
97
- The default registry API is `https://api.aipm-registry.com`. Use `--registry <url>`,
98
- `AIPM_REGISTRY_URL=<url>`, or `AIPM_REGISTRY=<url>` for local or private
99
- registries.
135
+ Default registry API: `https://api.aipm-registry.com`
136
+
137
+ For a local or private registry, use `--registry <url>`, or set `AIPM_REGISTRY_URL` / `AIPM_REGISTRY`.
138
+
139
+ ## Links
140
+
141
+ - **Registry & browse skills:** [aipm-registry.com](https://aipm-registry.com)
142
+ - **Publishing guide:** [aipm-registry.com/publish](https://aipm-registry.com/publish)
143
+ - **Docs & examples:** [aipm-registry.com/examples](https://aipm-registry.com/examples)
144
+ - **Source code:** [github.com/aipm-registry/aipm](https://github.com/aipm-registry/aipm)