@aipm-registry/cli 0.2.12 → 0.2.13

package/README.md

@@ -1,7 +1,25 @@
+# Search the registry at [aipm-registry.com](https://aipm-registry.com) for a skill
+
+
 # AIPM CLI
 
-AIPM installs project-ready AI skills into supported tools such as Cursor and
-Claude.
+**An Open source command-line tool for AI skills management and discovery [AIPM](https://aipm-registry.com)**
+
+## What is this?
+
+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).
+
+AIPM makes skills easy to **find, install, and share** — like npm, but for AI skills.
+
+This package gives you the `aipm` command. With it you can:
+
+- **Browse and install** skills from the public registry at **[aipm-registry.com](https://aipm-registry.com)**
+- **Add skills to your project** so your whole team uses the same instructions
+- **Publish your own skills** so others can install them
+
+No other AIPM packages are required — everything is bundled in one install.
+
+**Supported tools today:** Cursor and Claude (more targets at [aipm-registry.com/targets](https://aipm-registry.com/targets)).
 
 ## Install
 
@@ -9,91 +27,109 @@ Claude.
 npm install -g @aipm-registry/cli
 aipm --version
 aipm doctor
-aipm config
 ```
 
-## Use
+`aipm doctor` checks that your setup is ready. Run it if something does not work.
 
-Initialize a project:
+## Install skills in your project
+
+Start in any project folder:
 
 ```bash
 aipm init
 ```
 
-Install a skill from the public registry:
+*Search the registry at [aipm-registry.com](https://aipm-registry.com) for a skill:*
 
 ```bash
-aipm add @scope/name@1.0.0 --target cursor --ci
+aipm search sentry
 ```
 
-List installed skills:
+Results show version, supported tools, description, publisher, license, and size.
+
+Install a skill:
 
 ```bash
-aipm list
+aipm add @scope/name@1.0.0 --target cursor
 ```
 
-Search the registry:
+See what is installed:
 
 ```bash
-aipm search sentry
+aipm list
 ```
 
-Search results include package version, supported targets, description,
-publisher identity when available, license, and package size.
-
 Update installed skills:
 
 ```bash
 aipm update
 ```
 
-This package is bundled. Installing `@aipm-registry/cli` gives you the `aipm`
-command without needing to install any other AIPM npm packages manually.
+Browse more packages on the website: **[aipm-registry.com](https://aipm-registry.com)**
+
+## Publish your skill (public / private / organization-only)
 
-Publish a public skill:
+Share a skill with your team or the public registry.
+
+1. Create a free account at **[aipm-registry.com](https://aipm-registry.com)**
+2. Create an org and reserve your package name (for example `@team/review-helper`)
+3. Scaffold a new skill package:
 
 ```bash
 aipm publish init --name @team/review-helper --template code-review
 cd review-helper
-aipm publish explain # (optional)
+```
+
+1. Add your files and push:
+
+```bash
 aipm publish add .
-aipm publish status # (optional)
-aipm publish preview # (optional)
-aipm publish validate # (optional)
-aipm publish token --package @team/review-helper # (optional)
+aipm publish preview    # optional — see what will be uploaded
+aipm publish validate   # optional — check for problems
 AIPM_TOKEN=<5-minute-token> aipm publish push --yes
 ```
 
-Create an account on `https://aipm-registry.com`, create an org, reserve the
-package name, and generate the 5-minute token from the package dashboard.
+Get the short-lived publish token from your package page on **[aipm-registry.com/dashboard](https://aipm-registry.com/dashboard)**.
+
+**Starter templates:** `blank`, `code-review`, `issue-summary`, `release-notes`. They only set the initial `SKILL.md` — edit any file before publishing.
+
+**Already have a skill file?** Import it into an AIPM package:
 
-Use `.aipmignore` to exclude local-only files from publishing. AIPM also
-rejects common private key, env, Azure connection string, publish profile, and
-large package mistakes before upload.
+```bash
+aipm publish import ~/.codex/skills/review-helper --name @team/review-helper
+cd review-helper
+aipm publish add .
+```
 
-Helpful publishing commands:
+**Helpful extras:**
 
 ```bash
-aipm publish init --name @team/issue-summary --template issue-summary
-aipm publish init --name @team/release-notes --template release-notes
-aipm publish open --docs # (optional)
-aipm publish open --package @team/review-helper # (optional)
-aipm doctor --publish # (optional)
+aipm publish explain              # what publishing does
+aipm publish status               # staged files
+aipm publish token --package @team/review-helper
+aipm publish open --docs          # open publishing docs
+aipm publish open --package @team/review-helper
+aipm doctor --publish             # check publish setup
 ```
 
-Starter templates are `blank`, `code-review`, `issue-summary`, and
-`release-notes`. They only change the starter `SKILL.md`; you can edit every
-file before staging and publishing.
+Use `.aipmignore` to skip local-only files. Before upload, AIPM blocks common mistakes such as private keys, `.env` files, and oversized packages.
 
-If your AI tool already generated a skill or rule file, import it into an AIPM package folder:
+Full publishing guide: **[aipm-registry.com/publish](https://aipm-registry.com/publish)**
+
+## Configuration
 
 ```bash
-aipm publish import ~/.codex/skills/review-helper --name @team/review-helper
-cd review-helper
-aipm publish add .
-aipm publish preview # (optional)
+aipm config
 ```
 
-The default registry API is `https://api.aipm-registry.com`. Use `--registry <url>`,
-`AIPM_REGISTRY_URL=<url>`, or `AIPM_REGISTRY=<url>` for local or private
-registries.
+Default registry API: `https://api.aipm-registry.com`
+
+For a local or private registry, use `--registry <url>`, or set `AIPM_REGISTRY_URL` / `AIPM_REGISTRY`.
+
+## Links
+
+- **Registry & browse skills:** [aipm-registry.com](https://aipm-registry.com)
+- **Publishing guide:** [aipm-registry.com/publish](https://aipm-registry.com/publish)
+- **Docs & examples:** [aipm-registry.com/examples](https://aipm-registry.com/examples)
+- **Source code:** [github.com/aipm-registry/aipm](https://github.com/aipm-registry/aipm)
+

package/dist/bin.cjs

@@ -4176,7 +4176,8 @@ var init_manifest = __esm({
       description: external_exports.string().min(1),
       entry: external_exports.string().min(1),
       targets: external_exports.array(AiToolSchema).min(1),
-      license: external_exports.string().optional()
+      license: external_exports.string().optional(),
+      usage: external_exports.string().min(1).optional()
     });
   }
 });