kaimon-cli 0.1.45 → 0.1.46

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 (2) hide show
  1. package/README.md +19 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,10 +4,29 @@
4
4
 
5
5
  ## Installation
6
6
 
7
+ ### Global Installation (Recommended for Individual Use)
8
+
7
9
  ```bash
8
10
  npm install -g kaimon-cli
9
11
  ```
10
12
 
13
+ This installs the CLI globally, so you can run `kaimon` commands from any folder on your system.
14
+
15
+ ### Local Installation (Recommended for Teams/Projects)
16
+
17
+ ```bash
18
+ npm install --save-dev kaimon-cli
19
+ ```
20
+
21
+ Then use `npx kaimon` instead of `kaimon`:
22
+
23
+ ```bash
24
+ npx kaimon pull
25
+ npx kaimon push
26
+ ```
27
+
28
+ **Local installation benefits:** Version control your CLI version, team consistency, no global pollution.
29
+
11
30
  ## Quick Start
12
31
 
13
32
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kaimon-cli",
3
- "version": "0.1.45",
3
+ "version": "0.1.46",
4
4
  "minimumVersion": "0.1.45",
5
5
  "description": "CLI tool to sync Kaimon files (.md) with your codebase",
6
6
  "type": "module",