@mfjjs/ruflo-setup 0.1.7 → 0.1.8
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 +43 -21
- 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.8](https://gitlab.mfj.local:8022/mario/ruflo-setup/compare/v0.1.7...v0.1.8) (2026-03-13)
|
|
6
|
+
|
|
5
7
|
### [0.1.7](https://gitlab.mfj.local:8022/mario/ruflo-setup/compare/v0.1.6...v0.1.7) (2026-03-13)
|
|
6
8
|
|
|
7
9
|
|
package/README.md
CHANGED
|
@@ -9,8 +9,9 @@ Cross-platform npm CLI to bootstrap a project with Ruflo on Windows and Linux.
|
|
|
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
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,6 +35,47 @@ 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
|
+
## Usage
|
|
47
|
+
|
|
48
|
+
### Bootstrap
|
|
49
|
+
Use this once if you want Claude Code to expose the `/ruflo-setup` command globally.
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
ruflo-setup hooks init
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
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.
|
|
56
|
+
|
|
57
|
+
### Setup
|
|
58
|
+
Use these commands when you want to run the setup directly from a shell.
|
|
59
|
+
|
|
60
|
+
From the target project directory, run one of the following:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# full setup
|
|
64
|
+
ruflo-setup
|
|
65
|
+
|
|
66
|
+
# non-interactive
|
|
67
|
+
ruflo-setup --yes
|
|
68
|
+
|
|
69
|
+
# preview only
|
|
70
|
+
ruflo-setup --dry-run --skip-init
|
|
71
|
+
|
|
72
|
+
# skip global hook install
|
|
73
|
+
ruflo-setup --no-hooks
|
|
74
|
+
|
|
75
|
+
# hook operations
|
|
76
|
+
ruflo-setup hooks install
|
|
77
|
+
ruflo-setup hooks status
|
|
78
|
+
```
|
|
37
79
|
|
|
38
80
|
## Project structure
|
|
39
81
|
|
|
@@ -75,26 +117,6 @@ Flow:
|
|
|
75
117
|
- copies `templates/CLAUDE.md`
|
|
76
118
|
- installs global SessionStart hook (unless skipped)
|
|
77
119
|
|
|
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
120
|
## Local development with pnpm
|
|
99
121
|
|
|
100
122
|
From this repository root (`setup-ruflo/`):
|