vercel microfrontends
The vercel microfrontends command provides utilities for managing Vercel Microfrontends from the CLI.
| 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 command creates the group in the current team. If the current scope is not a team, the command exits with an error. 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 |
--project-default-route | Default route for a non-default project, in the format <project>=<route> (repeatable) |
-y, --yes | Skip creation confirmation prompt |
vercel microfrontends create-groupvercel microfrontends create-group --name="My Group" --project=web --project=docs --default-app=web --project-default-route=docs=/docs --yesAdd 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 microfrontends 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.
vercel microfrontends remove-from-group [options]| Option | Description |
|---|---|
-y, --yes | Skip the project-link prompt and removal confirmations, including the one for a project that is still in microfrontends.json. |
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 deletion confirmation. Combine with --group to delete without prompting. |
vercel microfrontends delete-groupvercel microfrontends delete-group --group="My Group" --yesInspect 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) |
--json | Output the group and project metadata as JSON |
vercel microfrontends inspect-groupvercel microfrontends inspect-group --group="My Group" --jsonvercel microfrontends inspect-group --group="My Group" --config-file-name=microfrontends.jsonc --jsonPull the remote microfrontends configuration to your local repository for development.
vercel microfrontends pull [options]| Option | Description |
|---|---|
-y, --yes | Skip confirmation when linking is required (for example, in non-interactive mode) |
--deployment | The deployment ID to use for pulling the microfrontends configuration |
vercel microfrontends pullvercel microfrontends pull --deployment 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?