Refactor: Remove Yeoman and switch to Oclif by OsamaRab3 · Pull Request #640 · hyperledger-labs/fablo

OsamaRab3 · 2025-11-19T16:50:44Z

Description

This PR introduces the initial setup for removing and fully migrating the CLI to Oclif.
The goal is to simplify the CLI implementation, remove the generator dependency, and make future features easier to maintain and extend.

All commands are currently working as expected, but I haven’t run the full automated test suite yet

Current Progress

Implemented so far

Replaced Yeoman-based commands with Oclif commands.
Added the new init implementation using Oclif.
fablo init now accepts the following optional features (order does not matter):

fablo init [node] [dev] [rest] [ccaas] [gateway]

Added initial Oclif commands for:
- up
- down
- start
- stop
- recreate
- prune

Basic usage examples

Run the network:

ffablo up -c fablo-config.json

The -c flag is optional if omitted, it will default to fablo-config.json just like the original Fablo CLI

Important Note

I temporarily named the executable ffablo to avoid conflicts with the existing fablo command during development.
Once the migration is complete and fully tested, the name will be switched back to fablo
I haven’t removed the old Yeoman-based code yet.
Once the new Oclif implementation is fully completed and fully tested, I will remove all legacy code.

OsamaRab3 · 2025-11-19T17:00:29Z

To run and test it locally, please follow these steps

npm install
npm run build
npm link

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

Signed-off-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

OsamaRab3 · 2026-03-01T01:38:05Z

+    "bin": "ffablo",
+    "commands": "./generators/commands",
+    "dirname": "ffablo",


Suggested change

"bin": "ffablo",

"commands": "./generators/commands",

"dirname": "ffablo",

"bin": "fablo",

"commands": "./generators/commands",

"dirname": "fablo",

OsamaRab3 · 2026-03-01T02:01:18Z

I believe we no longer need this file since we have migrated away from Yeoman. It does not seem to be used anywhere, so we can safely remove it.

OsamaRab3 · 2026-03-01T02:10:04Z

+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",


Do we need these scripts?

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

dzikowski · 2026-03-06T11:05:09Z

 }

 executeOnFabloDocker() {
+  # set -x


yes, we can remove that line

dzikowski · 2026-03-06T11:05:22Z

+  if [ -f /etc/passwd ]; then
+    fablo_workspace_params+=(
+      -v /etc/passwd:/etc/passwd:ro
+    )
+  fi
+
+  if [ -f /etc/group ]; then
+    fablo_workspace_params+=(
+      -v /etc/group:/etc/group:ro
+    )
+  fi
+


what does it do? do we need it?

dzikowski · 2026-03-06T11:06:26Z


  if [ -f "$FABLO_TARGET/fabric-docker.sh" ]; then
    echo "Executing Fablo Docker command: $1"
+    chmod +x "$FABLO_TARGET/fabric-docker.sh" || true


that should not be required. We should grant x permission when the file is created

Signed-off-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>

…f they exist Signed-off-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

…g and adjust output directories Signed-off-by: OsamaRab3 <osrab3@gmail.com>

…ted minimal files for security Signed-off-by: OsamaRab3 <osrab3@gmail.com>

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

OsamaRab3 added 18 commits December 4, 2025 11:58

init setup to remove yeoman and use oclif

41e7a28

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

intial fablo up

2a57fed

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital fablo stop

9258f62

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital fablo down

8cfa0b3

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

fablo splash

4c0bc8d

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital fablo prune

616cd0c

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital fablo recreate

14e2a1e

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital fablo start

79cd27a

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital fablo init

23c82cd

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital fablo export-topology

5fe9009

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital extend-config

6e9443f

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

move extend config to src dir

4a1b01f

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

remove old yeoman , unuseful commands

e4ca733

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

remove yeoman from entery point

ae3cfc2

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

fix: import lib path

5459362

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

inital validate and verrsion

2353cab

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

update setup-network, k8s ,list-version and list-compatible

8304167

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

utils for ejs templete

39fbcb4

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

OsamaRab3 force-pushed the del-yeoman branch from 208390a to 39fbcb4 Compare December 4, 2025 09:58

dzikowski and others added 10 commits December 5, 2025 15:50

Iterate on Dockerfile and docker-entrypoint.sh

a4ff2cf

Signed-off-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>

Iterate on docker entrypoint and init command

fa80133

Signed-off-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>

Iterate on docker entrypoint and fix build in fablo-build

3c609d4

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

fix path to ref into docker and setup-netwrok

9ec52bd

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

Merge branch 'main' into del-yeoman

9aae49b

uncomment export-toplogy and fix packege.json

922eaeb

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

Merge branch 'main' into del-yeoman

0e7f344

fix: export-topology command to export to optional file

5618bad

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

fix: solve oclif warnings

e5e6652

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

setup e2e test

da52868

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

OsamaRab3 added 2 commits March 1, 2026 02:16

fix system error in ci

4b1ce0a

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

fix: update exportNetworkTopology to use correct config path

ed39104

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

OsamaRab3 commented Mar 1, 2026

View reviewed changes

OsamaRab3 added 3 commits March 4, 2026 23:45

refactor: clean up unused code and improve logging in SetupDocker

64122d1

Signed-off-by: OsamaRab3 <osrab3@gmail.com>

Merge branch 'main' into del-yeoman

8fa55a2

update snpashots

4b4ce98

Signed-off-by: OsamaRab3 <osrab3@gmail.com>