@mfjjs/ruflo-setup 0.1.8 → 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.
- package/CHANGELOG.md +2 -0
- package/README.md +24 -11
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
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
|
+
|
|
5
7
|
### [0.1.8](https://gitlab.mfj.local:8022/mario/ruflo-setup/compare/v0.1.7...v0.1.8) (2026-03-13)
|
|
6
8
|
|
|
7
9
|
### [0.1.7](https://gitlab.mfj.local:8022/mario/ruflo-setup/compare/v0.1.6...v0.1.7) (2026-03-13)
|
package/README.md
CHANGED
|
@@ -2,14 +2,14 @@
|
|
|
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
|
-
## Requirements
|
|
12
|
+
## 📋 Requirements
|
|
13
13
|
<details>
|
|
14
14
|
<summary>Click to toggle visibility</summary>
|
|
15
15
|
|
|
@@ -37,13 +37,26 @@ corepack prepare pnpm@latest --activate
|
|
|
37
37
|
```
|
|
38
38
|
</details>
|
|
39
39
|
|
|
40
|
-
## Installation
|
|
40
|
+
## 📦 Installation
|
|
41
41
|
|
|
42
42
|
```powershell
|
|
43
43
|
pnpm -i -g @mfjjs/ruflo-setup
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
##
|
|
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
|
|
47
60
|
|
|
48
61
|
### Bootstrap
|
|
49
62
|
Use this once if you want Claude Code to expose the `/ruflo-setup` command globally.
|
|
@@ -77,7 +90,7 @@ ruflo-setup hooks install
|
|
|
77
90
|
ruflo-setup hooks status
|
|
78
91
|
```
|
|
79
92
|
|
|
80
|
-
## Project structure
|
|
93
|
+
## 🗂️ Project structure
|
|
81
94
|
|
|
82
95
|
- `package.json`: npm metadata, scripts, and `bin` mapping
|
|
83
96
|
- `bin/ruflo-setup.js`: executable entry file the shell runs
|
|
@@ -89,7 +102,7 @@ ruflo-setup hooks status
|
|
|
89
102
|
- `claude-hooks/check-ruflo.cjs`: SessionStart hook payload
|
|
90
103
|
- `tests/cli.test.mjs`: smoke tests for CLI behavior
|
|
91
104
|
|
|
92
|
-
## What the command line calls
|
|
105
|
+
## 🖥️ What the command line calls
|
|
93
106
|
|
|
94
107
|
After install/link, `ruflo-setup` resolves to your package `bin` entry:
|
|
95
108
|
|
|
@@ -103,7 +116,7 @@ After install/link, `ruflo-setup` resolves to your package `bin` entry:
|
|
|
103
116
|
|
|
104
117
|
The shell shim launches `bin/ruflo-setup.js`, which imports `src/cli.js`, which dispatches to setup or hook subcommands.
|
|
105
118
|
|
|
106
|
-
## How the CLI entry point works
|
|
119
|
+
## ⚙️ How the CLI entry point works
|
|
107
120
|
|
|
108
121
|
Flow:
|
|
109
122
|
|
|
@@ -117,7 +130,7 @@ Flow:
|
|
|
117
130
|
- copies `templates/CLAUDE.md`
|
|
118
131
|
- installs global SessionStart hook (unless skipped)
|
|
119
132
|
|
|
120
|
-
## Local development with pnpm
|
|
133
|
+
## 🛠️ Local development with pnpm
|
|
121
134
|
|
|
122
135
|
From this repository root (`setup-ruflo/`):
|
|
123
136
|
|
|
@@ -127,7 +140,7 @@ pnpm test
|
|
|
127
140
|
pnpm run test:cli
|
|
128
141
|
```
|
|
129
142
|
|
|
130
|
-
## Link locally so command works everywhere
|
|
143
|
+
## 🔗 Link locally so command works everywhere
|
|
131
144
|
|
|
132
145
|
```bash
|
|
133
146
|
# from setup-ruflo/
|
|
@@ -139,7 +152,7 @@ ruflo-setup --dry-run --skip-init
|
|
|
139
152
|
|
|
140
153
|
This is the fast edit loop: change files in `src/`, rerun `ruflo-setup`, and behavior updates immediately without reinstall.
|
|
141
154
|
|
|
142
|
-
## Simulate a real install (deploy-style testing)
|
|
155
|
+
## 🧪 Simulate a real install (deploy-style testing)
|
|
143
156
|
|
|
144
157
|
Create a tarball and install it into a clean test location.
|
|
145
158
|
|
|
@@ -154,7 +167,7 @@ ruflo-setup --dry-run --skip-init
|
|
|
154
167
|
|
|
155
168
|
This tests exactly what users get from a package install.
|
|
156
169
|
|
|
157
|
-
## Global hook behavior
|
|
170
|
+
## 🪝 Global hook behavior
|
|
158
171
|
|
|
159
172
|
`ruflo-setup` installs a global Claude SessionStart command hook that runs:
|
|
160
173
|
|