---
title: vercel microfrontends
product: vercel
url: /docs/cli/microfrontends
canonical_url: "https://vercel.com/docs/cli/microfrontends"
last_updated: 2026-06-04
type: reference
prerequisites:
  - /docs/cli
related:
  - /docs/microfrontends
  - /docs/microfrontends/local-development
  - /docs/cli/global-options
summary: Manage microfrontends groups from the CLI. Learn how to create groups, inspect group metadata, add and remove projects, and pull configuration for...
install_vercel_plugin: npx plugins add vercel/vercel-plugin
search_with_vercel_cli: npx vercel@latest docs search "<query>"
---

# vercel microfrontends

The `vercel microfrontends` command provides utilities for managing Vercel Microfrontends from the CLI.


<!-- docsgraph:related -->
## Related pages

> **For AI agents:** Follow these links to understand how this page connects to the rest of the Vercel ecosystem. For the full cross-link map (inbound, outbound, prerequisites, and semantic neighbors), see the .graph.md link below.

- [Manage Vercel Microfrontends with AI Agents and the CLI](https://vercel.com/changelog/manage-vercel-microfrontends-with-ai-agents-and-the-cli)
- [Managing microfrontends](https://vercel.com/docs/microfrontends/managing-microfrontends) — Learn how to manage your microfrontends on Vercel.
- [Create a microfrontends group with applications](https://vercel.com/docs/rest-api/microfrontends/create-a-microfrontends-group-with-applications) — POST /v1/microfrontends/group — Creates a microfrontends group and attaches multiple projects in a single request.
- [Getting started with microfrontends](https://vercel.com/docs/microfrontends/quickstart) — Learn how to get started with microfrontends on Vercel.
- [Microfrontends](https://vercel.com/docs/agent-resources/vercel-mcp/tools/microfrontends) — Vercel MCP tools for microfrontends.
- [Microfrontends Configuration](https://vercel.com/docs/microfrontends/configuration) — Configure your microfrontends.json.

Full cross-link map for this page: [/docs/cli/microfrontends.graph.md](/docs/cli/microfrontends.graph.md)
<!-- /docsgraph:related -->

The `vercel mf` alias is deprecated since Vercel CLI 65.2.0. It still works, but prints a deprecation warning that names `vercel microfrontends`.

> **💡 Note:** To learn more about the architecture and config format, see
> [Microfrontends on Vercel](/docs/microfrontends).
> For a polyrepo setup walkthrough, see
> [Accessing the configuration file](/docs/microfrontends/local-development#accessing-the-configuration-file).

## Subcommands

| Subcommand                                | Description                                     |
| ----------------------------------------- | ----------------------------------------------- |
| [`create-group`](#create-group)           | Create a new microfrontends group               |
| [`add-to-group`](#add-to-group)           | Add the current project to a group              |
| [`remove-from-group`](#remove-from-group) | Remove the current project from its group       |
| [`delete-group`](#delete-group)           | Delete a microfrontends group                   |
| [`inspect-group`](#inspect-group)         | Inspect a microfrontends group and its projects |
| [`pull`](#pull)                           | Pull remote configuration for local development |

## create-group

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.

```bash filename="terminal"
vercel microfrontends create-group [options]
```

### 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                                                       |

### Examples

#### Create a group interactively

```bash filename="terminal"
vercel microfrontends create-group
```

#### Create a group with flags

```bash filename="terminal"
vercel microfrontends create-group --name="My Group" --project=web --project=docs --default-app=web --project-default-route=docs=/docs --yes
```

## add-to-group

Add 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.

```bash filename="terminal"
vercel microfrontends add-to-group [options]
```

### Options

| Option            | Description                                           |
| ----------------- | ----------------------------------------------------- |
| `--group`         | Name of the microfrontends group to add to            |
| `--default-route` | Default route for this project (for example, `/docs`) |

### Examples

#### Add the current project to a group interactively

```bash filename="terminal"
vercel microfrontends add-to-group
```

#### Add the current project to a group with flags

```bash filename="terminal"
vercel microfrontends add-to-group --group="My Group" --default-route=/docs
```

## remove-from-group

Remove the current project from its microfrontends group so it's no longer part of the composed application.

> **💡 Note:** 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`.

```bash filename="terminal"
vercel microfrontends remove-from-group [options]
```

### 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`. |

### Examples

#### Remove the current project from its group

```bash filename="terminal"
vercel microfrontends remove-from-group
```

## delete-group

Delete a microfrontends group and all its settings. This action is not reversible.

```bash filename="terminal"
vercel microfrontends delete-group [options]
```

### 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. |

### Examples

#### Delete a group interactively

```bash filename="terminal"
vercel microfrontends delete-group
```

#### Delete a group without prompts

```bash filename="terminal"
vercel microfrontends delete-group --group="My Group" --yes
```

## inspect-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`.

```bash filename="terminal"
vercel microfrontends inspect-group [options]
```

### 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                                                                    |

### Examples

#### Inspect a group interactively

```bash filename="terminal"
vercel microfrontends inspect-group
```

#### Inspect a group as JSON

```bash filename="terminal"
vercel microfrontends inspect-group --group="My Group" --json
```

#### Inspect a group with a custom config filename

```bash filename="terminal"
vercel microfrontends inspect-group --group="My Group" --config-file-name=microfrontends.jsonc --json
```

## pull

Pull the remote microfrontends configuration to your local repository for development.

> **💡 Note:** For a polyrepo setup walkthrough, see
> [Accessing the configuration file](/docs/microfrontends/local-development#accessing-the-configuration-file).
> This subcommand requires Vercel CLI 44.2.2 or newer. The `--deployment` option requires Vercel CLI 65.0.0 or newer.

```bash filename="terminal"
vercel microfrontends pull [options]
```

### 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             |

### Examples

#### Pull configuration for the linked project

```bash filename="terminal"
vercel microfrontends pull
```

#### Pull configuration for a specific deployment

```bash filename="terminal"
vercel microfrontends pull --deployment dpl_123xyz
```

## Global Options

The following [global options](/docs/cli/global-options) can be passed when using the `vercel microfrontends` command:

- [`--cwd`](/docs/cli/global-options#current-working-directory)
- [`--debug`](/docs/cli/global-options#debug)
- [`--global-config`](/docs/cli/global-options#global-config)
- [`--help`](/docs/cli/global-options#help)
- [`--local-config`](/docs/cli/global-options#local-config)
- [`--no-color`](/docs/cli/global-options#no-color)
- [`--non-interactive`](/docs/cli/global-options#non-interactive)
- [`--scope`](/docs/cli/global-options#scope)
- [`--token`](/docs/cli/global-options#token)
- [`--version`](/docs/cli/global-options#version)

For more information on global options and their usage, refer to the [options section](/docs/cli/global-options).

## Search the docs from your terminal

Search the Vercel docs and read pages as Markdown with the Vercel CLI. No login required.

```bash
# Find docs pages by keyword
npx vercel@latest docs search "environment variables"
npx vercel@latest docs search "function timeout"

# Print a docs page as Markdown, by path or URL
npx vercel@latest docs inspect <page>
```

---

[View full sitemap](/docs/sitemap)


If you encounter incorrect information, can’t find what you need, need a capability Vercel doesn’t currently offer, or have any other feedback to report, please do it by following the instructions at https://vercel.com/feedback.md.
