remove Yeoman and switched to Oclif for the CLI 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

package.json

+    "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

src/app/index.ts

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

package.json

+    "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

fablo.sh

 }

 executeOnFabloDocker() {
+  # set -x


yes, we can remove that line

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

fablo.sh

+  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

fablo.sh


  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

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

tsconfig.json

-    "noEmit": true,
+    // "noEmit": true,
    "rootDir": "./",
+    "outDir": "./generators",


ultimately we should change it to dist an update references

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

e2e-network/docker/test-01-v3-simple.sh

 networkUp() {
  "$FABLO_HOME/fablo-build.sh"
-  (cd "$TEST_TMP" && "$FABLO_HOME/fablo.sh" init node dev)
+  (cd "$TEST_TMP" && "$FABLO_HOME/fablo.sh" init --node && cat "$TEST_TMP/fablo-config.json")


the test looks different because we were checking node/dev mode. Here we have no dev/ccaas mode

dzikowski · 2026-03-06T11:17:56Z

Dockerfile

-RUN npm install --global --silent yo

 # copy fablo files
 COPY generators /fablo/generators


dzikowski · 2026-03-06T11:18:38Z

Dockerfile

 # Add a yeoman user because Yeoman freaks out and runs setuid(501).
 # This was because less technical people would run Yeoman as root and cause problems.
 # Setting uid to 501 here since it's already a random number being thrown around.
 # @see https://github.com/yeoman/yeoman.github.io/issues/282
 # @see https://github.com/cthulhu666/docker-yeoman/blob/master/Dockerfile
 # @see https://github.com/phase2/docker-yeoman/blob/master/Dockerfile
 RUN adduser -D -u 501 yeoman && \
  echo "yeoman ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers


we don't need that weird user setup anymore

dzikowski · 2026-03-06T11:19:21Z

docker-entrypoint.sh

  if [ "$(id -u)" = 0 ]; then
-    # root user detected, running as yeoman user
-    sudo chown -R yeoman:yeoman "$yeoman_target_dir"
+    # root user detected, running as yeoman user (keeping for compatibility)
+    sudo chown -R yeoman:yeoman "$target_dir"
    # shellcheck disable=SC2086
-    (cd "$yeoman_target_dir" && sudo -E -u yeoman yo --no-insight $command_with_params)
-    sudo chown -R root:root "$yeoman_target_dir"
+    (cd "$target_dir" && sudo -E -u yeoman node --no-warnings /fablo/bin/run.mjs $command_with_params)
+    sudo chown -R root:root "$target_dir"
  else
    # shellcheck disable=SC2086
-    (cd "$yeoman_target_dir" && yo --no-insight $command_with_params)
+    (cd "$target_dir" && node --no-warnings /fablo/bin/run.mjs $command_with_params)
  fi


we probably don't need it anymore

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>

dzikowski reviewed Mar 6, 2026

View reviewed changes

fablo.sh

}

executeOnFabloDocker() {

# set -x

Copy link

Contributor

dzikowski Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, we can remove that line

dzikowski reviewed Mar 6, 2026

View reviewed changes

Dockerfile

RUN npm install --global --silent yo

# copy fablo files

COPY generators /fablo/generators

Copy link

Contributor

dzikowski Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

=> dist

dzikowski reviewed Mar 6, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

remove Yeoman and switched to Oclif for the CLI#640

remove Yeoman and switched to Oclif for the CLI#640
OsamaRab3 wants to merge 33 commits intohyperledger-labs:mainfrom
OsamaRab3:del-yeoman

OsamaRab3 commented Nov 19, 2025

Uh oh!

OsamaRab3 commented Nov 19, 2025

Uh oh!

OsamaRab3 Mar 1, 2026

Uh oh!

OsamaRab3 Mar 1, 2026

Uh oh!

OsamaRab3 Mar 1, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

dzikowski Mar 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

OsamaRab3 commented Nov 19, 2025

Description

Current Progress

Basic usage examples

Important Note

Uh oh!

OsamaRab3 commented Nov 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants