rules-md 1.0.0 → 1.1.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 (3) hide show
  1. package/README.md +13 -3
  2. package/index.js +13 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -4,7 +4,7 @@ A command-line tool that allows you to manage a single **Source of Truth** markd
4
4
 
5
5
  ## Features
6
6
 
7
- - **Centralized Source of Truth**: Define your persona, coding standards, preferred libraries, and workflow configurations in one place (defaults to `~/global-rules.md`).
7
+ - **Centralized Source of Truth**: Define your persona, coding standards, preferred libraries, and workflow configurations in one place (defaults to `~/RULES.md`).
8
8
  - **Interactive Console UI**: An easy-to-use checklist terminal interface to select which agents to target.
9
9
  - **Smart Merger**: If you already have existing rule files for specific agents, you can append their contents to your Source of Truth or back them up.
10
10
  - **Robust Symlink/Hardlink Fallbacks**:
@@ -15,9 +15,17 @@ A command-line tool that allows you to manage a single **Source of Truth** markd
15
15
 
16
16
  ---
17
17
 
18
- ## Installation & Running
18
+ ## Quickstart 🚀
19
19
 
20
- Since it has zero external dependencies, you can run it directly using Node.js.
20
+ The easiest way to run the tool is directly via `npx` without any installation:
21
+
22
+ ```bash
23
+ npx rules-md
24
+ ```
25
+
26
+ ---
27
+
28
+ ## Local Installation & Running
21
29
 
22
30
  ### Run directly with Node
23
31
 
@@ -62,6 +70,8 @@ rules-md
62
70
  | **OpenCode** | `~/.config/opencode/AGENTS.md` | Standard OpenCode path. |
63
71
  | **Pi Agent** | `~/.pi/agent/AGENTS.md` | Pi Agent instructions path. |
64
72
  | **OpenAI Codex** | `~/.codex/AGENTS.md` | OpenAI Codex agent global rules file. |
73
+ | **Kimi Code CLI** | `~/.kimi-code/AGENTS.md` | Kimi Code CLI global instructions. |
74
+ | **Mistral Vibe CLI** | `~/.vibe/AGENTS.md` | Mistral Vibe CLI global rules. |
65
75
 
66
76
  ---
67
77
 
package/index.js CHANGED
@@ -106,6 +106,18 @@ const tools = [
106
106
  path: "~/.codex/AGENTS.md",
107
107
  desc: "Codex agent global instructions.",
108
108
  },
109
+ {
110
+ id: "kimi",
111
+ name: "Kimi Code CLI",
112
+ path: "~/.kimi-code/AGENTS.md",
113
+ desc: "Kimi Code CLI global instructions.",
114
+ },
115
+ {
116
+ id: "vibe",
117
+ name: "Mistral Vibe CLI",
118
+ path: "~/.vibe/AGENTS.md",
119
+ desc: "Mistral Vibe CLI global rules.",
120
+ },
109
121
  ];
110
122
 
111
123
  // Helper to resolve paths with env vars and tilde
@@ -309,7 +321,7 @@ async function main() {
309
321
  };
310
322
 
311
323
  // 1. Confirm Source of Truth file
312
- const defaultSource = "~/global-rules.md";
324
+ const defaultSource = "~/RULES.md";
313
325
  const sourcePrompt = await prompts(
314
326
  {
315
327
  type: "text",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rules-md",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Interactive CLI tool to symlink/hardlink coding agent rules to a central Source of Truth",
5
5
  "main": "index.js",
6
6
  "bin": {