Skip to content

CLI to interact with the Micro-Frontend Framework applications

Notifications You must be signed in to change notification settings

micro-frontend-frameworks/cli

Repository files navigation

@mfe-frameworks/cli

oclif Version Downloads/week License

Usage

$ npm install -g @mfe-frameworks/cli
$ mfe COMMAND
running command...
$ mfe (-v|--version|version)
@mfe-frameworks/cli/0.0.3 darwin-arm64 node-v16.13.0
$ mfe --help [COMMAND]
USAGE
  $ mfe COMMAND
...

Commands

mfe create

creates a new micro-frontend application

USAGE
  $ mfe create

OPTIONS
  --poc=nextjs-run-time-integration|nextjs-build-time-integration

EXAMPLE
  $ mfe create

See code: src/commands/create.ts

mfe help [COMMAND]

display help for mfe

USAGE
  $ mfe help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mfe install [TENANT]

installs a published micro-frontend application on a tenant

USAGE
  $ mfe install [TENANT]

ARGUMENTS
  TENANT  (glowing-fiesta|vigilant-octo-sniffle|redesigned-robot) [default: glowing-fiesta] output file

EXAMPLE
  $ mfe install

See code: src/commands/install.ts

mfe publish

publishes a patched version of the micro-frontend application

USAGE
  $ mfe publish

EXAMPLE
  $ mfe publish

See code: src/commands/publish.ts

Development

  • Clone this repo
  • Clone the builder and the registry application
  • Get your API keys for each of the services above
  • Start the builder, and than start the registry
  • Start playing with it