vercel microfrontends
The vercel microfrontends command (alias: vercel mf) provides utilities for managing Vercel Microfrontends from the CLI.
To learn more about the architecture and config format, see Microfrontends on Vercel. For a polyrepo setup walkthrough, see Accessing the configuration file.
| Subcommand | Description |
|---|---|
create-group | Create a new microfrontends group |
add-to-group | Add the current project to a group |
remove-from-group | Remove the current project from its group |
delete-group | Delete a microfrontends group |
inspect-group | Inspect a microfrontends group and its projects |
pull | Pull remote configuration for local development |
Create a new microfrontends group to compose multiple projects into one cohesive application with shared routing. The group is created in the current scope (team or user). The command is interactive if options are omitted.
vercel microfrontends create-group [options]| Option | Description |
|---|---|
--name | Name of the microfrontends group |
--project | Project name to include (repeatable) |
--default-app | Project name for the default application |
--default-route | Default route for the default application |
vercel microfrontends create-groupvercel mf create-group --name="My Group" --project=web --project=docs --default-app=webAdd the current project to a microfrontends group as a child application. The project can then be independently deployed as part of the group. The command is interactive if options are omitted.
To set a project as the default application, use create-group with the --default-app option or configure it in the dashboard.
vercel microfrontends add-to-group [options]| Option | Description |
|---|---|
--group | Name of the microfrontends group to add to |
--default-route | Default route for this project (for example, /docs) |
vercel microfrontends add-to-groupvercel mf add-to-group --group="My Group" --default-route=/docsRemove the current project from its microfrontends group so it's no longer part of the composed application.
You cannot remove the default application from a group using the CLI. To remove the default application, use the dashboard or delete the entire group with delete-group.
vercel microfrontends remove-from-group [options]| Option | Description |
|---|---|
-y, --yes | Skip the project-link prompt (does not skip the removal confirmation) |
vercel microfrontends remove-from-groupDelete a microfrontends group and all its settings. This action is not reversible.
vercel microfrontends delete-group [options]| Option | Description |
|---|---|
--group | Name or ID of the microfrontends group to delete |
-y, --yes | Skip the project-link prompt (does not skip the deletion confirmation) |
vercel microfrontends delete-groupvercel mf delete-group --group="My Group"Inspect a microfrontends group and return metadata about the group and its projects. This command is useful for setup automation and scripts.
If you omit --group, the command is interactive and lets you select a group. In non-interactive environments, pass --group.
vercel microfrontends inspect-group [options]| Option | Description |
|---|---|
--group | Name, slug, or ID of the microfrontends group to inspect |
--config-file-name | Custom microfrontends config file path/name relative to the default app root (must end with .json or .jsonc) |
--format | Output format. Use json for machine-readable output |
vercel microfrontends inspect-groupvercel mf inspect-group --group="My Group" --format=jsonvercel mf inspect-group --group="My Group" --config-file-name=microfrontends.jsonc --format=jsonPull the remote microfrontends configuration to your local repository for development.
For a polyrepo setup walkthrough, see Accessing the configuration file. This subcommand requires Vercel CLI 44.2.2 or newer.
vercel microfrontends pull [options]| Option | Description |
|---|---|
--dpl | Deployment ID or URL to pull configuration from |
vercel microfrontends pullvercel mf pull --dpl dpl_123xyzThe following global options can be passed when using the vercel microfrontends command:
For more information on global options and their usage, refer to the options section.
Was this helpful?