@mfjjs/ruflo-setup 0.1.7 → 0.1.9

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/CHANGELOG.md +4 -0
  2. package/README.md +65 -30
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ### [0.1.9](https://gitlab.mfj.local:8022/mario/ruflo-setup/compare/v0.1.8...v0.1.9) (2026-03-13)
6
+
7
+ ### [0.1.8](https://gitlab.mfj.local:8022/mario/ruflo-setup/compare/v0.1.7...v0.1.8) (2026-03-13)
8
+
5
9
  ### [0.1.7](https://gitlab.mfj.local:8022/mario/ruflo-setup/compare/v0.1.6...v0.1.7) (2026-03-13)
6
10
 
7
11
 
package/README.md CHANGED
@@ -2,15 +2,16 @@
2
2
 
3
3
  Cross-platform npm CLI to bootstrap a project with Ruflo on Windows and Linux.
4
4
 
5
- ## What this project is
5
+ ## 📘 What this project is
6
6
 
7
7
  `@mfjjs/ruflo-setup` implements the setup with a Node-based CLI command:
8
8
 
9
9
  - Package name: `@mfjjs/ruflo-setup`
10
10
  - Command name: `ruflo-setup`
11
11
  - Platform support: Windows and Linux (plus macOS by default)
12
-
13
- ## Requirements
12
+ ## 📋 Requirements
13
+ <details>
14
+ <summary>Click to toggle visibility</summary>
14
15
 
15
16
  - Node.js 20+
16
17
  - pnpm available on PATH
@@ -34,8 +35,62 @@ Alternative (all platforms with recent Node.js):
34
35
  corepack enable
35
36
  corepack prepare pnpm@latest --activate
36
37
  ```
38
+ </details>
39
+
40
+ ## 📦 Installation
41
+
42
+ ```powershell
43
+ pnpm -i -g @mfjjs/ruflo-setup
44
+ ```
45
+
46
+ ## 💡 Why You Need This
47
+
48
+ If you’re working on:
49
+
50
+ * A brownfield application that never had RuFlow configured, or
51
+ * A brand‑new project that hasn’t been set up with RuFlow yet,
52
+
53
+ …then you currently have to configure RuFlow manually in each project. That means recreating the same structure, wiring, and boilerplate over and over.
54
+
55
+ The new command eliminates all of that. When you run it inside a project, it automatically generates the required RuFlow scaffolding — including all the files that belong in the folder — so every project starts from a clean, consistent baseline.
56
+
57
+ You only need to do this once in each folder. Just run the command and you’re ready to go.
58
+
59
+ ## 🚀 Usage
60
+
61
+ ### Bootstrap
62
+ Use this once if you want Claude Code to expose the `/ruflo-setup` command globally.
63
+
64
+ ```bash
65
+ ruflo-setup hooks init
66
+ ```
67
+
68
+ After that, when you open Claude Code in a project that does not already have Ruflo configured, you can run [**/ruflo-setup**](noop:) to start the setup flow.
69
+
70
+ ### Setup
71
+ Use these commands when you want to run the setup directly from a shell.
72
+
73
+ From the target project directory, run one of the following:
74
+
75
+ ```bash
76
+ # full setup
77
+ ruflo-setup
37
78
 
38
- ## Project structure
79
+ # non-interactive
80
+ ruflo-setup --yes
81
+
82
+ # preview only
83
+ ruflo-setup --dry-run --skip-init
84
+
85
+ # skip global hook install
86
+ ruflo-setup --no-hooks
87
+
88
+ # hook operations
89
+ ruflo-setup hooks install
90
+ ruflo-setup hooks status
91
+ ```
92
+
93
+ ## 🗂️ Project structure
39
94
 
40
95
  - `package.json`: npm metadata, scripts, and `bin` mapping
41
96
  - `bin/ruflo-setup.js`: executable entry file the shell runs
@@ -47,7 +102,7 @@ corepack prepare pnpm@latest --activate
47
102
  - `claude-hooks/check-ruflo.cjs`: SessionStart hook payload
48
103
  - `tests/cli.test.mjs`: smoke tests for CLI behavior
49
104
 
50
- ## What the command line calls
105
+ ## 🖥️ What the command line calls
51
106
 
52
107
  After install/link, `ruflo-setup` resolves to your package `bin` entry:
53
108
 
@@ -61,7 +116,7 @@ After install/link, `ruflo-setup` resolves to your package `bin` entry:
61
116
 
62
117
  The shell shim launches `bin/ruflo-setup.js`, which imports `src/cli.js`, which dispatches to setup or hook subcommands.
63
118
 
64
- ## How the CLI entry point works
119
+ ## ⚙️ How the CLI entry point works
65
120
 
66
121
  Flow:
67
122
 
@@ -75,27 +130,7 @@ Flow:
75
130
  - copies `templates/CLAUDE.md`
76
131
  - installs global SessionStart hook (unless skipped)
77
132
 
78
- ## Usage
79
-
80
- ```bash
81
- # full setup
82
- ruflo-setup
83
-
84
- # non-interactive
85
- ruflo-setup --yes
86
-
87
- # preview only
88
- ruflo-setup --dry-run --skip-init
89
-
90
- # skip global hook install
91
- ruflo-setup --no-hooks
92
-
93
- # hook operations
94
- ruflo-setup hooks install
95
- ruflo-setup hooks status
96
- ```
97
-
98
- ## Local development with pnpm
133
+ ## 🛠️ Local development with pnpm
99
134
 
100
135
  From this repository root (`setup-ruflo/`):
101
136
 
@@ -105,7 +140,7 @@ pnpm test
105
140
  pnpm run test:cli
106
141
  ```
107
142
 
108
- ## Link locally so command works everywhere
143
+ ## 🔗 Link locally so command works everywhere
109
144
 
110
145
  ```bash
111
146
  # from setup-ruflo/
@@ -117,7 +152,7 @@ ruflo-setup --dry-run --skip-init
117
152
 
118
153
  This is the fast edit loop: change files in `src/`, rerun `ruflo-setup`, and behavior updates immediately without reinstall.
119
154
 
120
- ## Simulate a real install (deploy-style testing)
155
+ ## 🧪 Simulate a real install (deploy-style testing)
121
156
 
122
157
  Create a tarball and install it into a clean test location.
123
158
 
@@ -132,7 +167,7 @@ ruflo-setup --dry-run --skip-init
132
167
 
133
168
  This tests exactly what users get from a package install.
134
169
 
135
- ## Global hook behavior
170
+ ## 🪝 Global hook behavior
136
171
 
137
172
  `ruflo-setup` installs a global Claude SessionStart command hook that runs:
138
173
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mfjjs/ruflo-setup",
3
- "version": "0.1.7",
3
+ "version": "0.1.9",
4
4
  "description": "Cross-platform setup CLI for Ruflo + Claude Flow projects",
5
5
  "type": "module",
6
6
  "bin": {