@cmodjs/cli 0.1.1 → 0.1.3
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/README.md +7 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
# @cmodjs/cli
|
|
2
2
|
|
|
3
|
-
The `cmod` command
|
|
3
|
+
The `cmod` command of Claude Mod Manager. Claude Mod Manager (CMod) installs, tries, builds, checks, and publishes Claude Code mods: plugins with hooks, panes, slash commands, tools, permission rules, and an install step that runs with your consent.
|
|
4
4
|
|
|
5
5
|
```sh
|
|
6
6
|
npm i -g @cmodjs/cli
|
|
7
7
|
cmod new my-mod
|
|
8
8
|
```
|
|
9
9
|
|
|
10
|
-
`cmod` runs the newest cmod program on this machine, and downloads its own version from the GitHub release the first time. A mod imports the library from [@cmodjs/core](https://www.npmjs.com/package/@cmodjs/core).
|
|
10
|
+
`cmod` runs the newest cmod program on this machine, and downloads its own version from the GitHub release the first time. `cmod --help` lists every command. A mod imports the library from [@cmodjs/core](https://www.npmjs.com/package/@cmodjs/core).
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
## Docs
|
|
13
|
+
|
|
14
|
+
The mod author docs ship inside `@cmodjs/core`, so a mod's `node_modules/@cmodjs/core/docs/index.md` is their map. [commands.md](https://github.com/heyJordanParker/cmod/blob/main/core/docs/commands.md) covers every `cmod` command.
|
|
15
|
+
|
|
16
|
+
The CMod plugin and the `cmod` source live at [github.com/heyJordanParker/cmod](https://github.com/heyJordanParker/cmod).
|