mfui-create-app

Experimental — This tool is in an early stage of development. APIs, generated project structure, and behavior may change without notice in future releases.

A CLI tool to scaffold a new MFUI app with Vite + React.

Overview

mfui-create-app is designed primarily for use with AI coding agents (such as Claude Code) when rapidly prototyping or bootstrapping a new product on top of MFUI. By giving an agent access to this tool, it can set up a fully configured MFUI project in a single step — without manual scaffolding — so you can immediately start describing what you want to build.

It can also be run directly from the command line when you prefer to set up a project yourself.

Requirements

• Node.js ≥18
• npm ≥7

Usage with AI Agents

When using an AI agent to create a new prototype or product, instruct it to run this tool non-interactively. The agent can scaffold the project, install dependencies, and start implementing your requirements right away.

Example prompt to your agent:

Create a new MFUI app called my-prototype and start implementing a dashboard page.

The agent will run:

npx @moneyforward/mfui-create-app my-prototype --description "My prototype" --no-git --skip-install

Because the tool exposes all options as CLI flags, agents can drive it without any interactive prompts.

Manual Usage

Run directly with npx (recommended)

npx @moneyforward/mfui-create-app

Pass the project name as an argument

npx @moneyforward/mfui-create-app my-app

The CLI will prompt you for the following information:

| Prompt | Description | Default | |--------|-------------|---------| | Project name | Name of the new project directory | my-mfui-app | | Project description | Short description written into package.json | (empty) | | Initialize a git repository? | Run git init in the generated project | Yes | | Install dependencies? | Run npm install after scaffolding | Yes |

Non-interactive mode

All prompts can be skipped by supplying CLI flags:

npx @moneyforward/mfui-create-app my-app \
  --description "My MFUI application" \
  --no-git \
  --skip-install

| Flag | Description | |------|-------------| | [project-name] | Positional argument for the project name | | -d, --description <text> | Project description | | --no-git | Skip git initialization | | --skip-install | Skip npm install |

What gets generated

The scaffolded project is a Vite + React + TypeScript app pre-configured with MFUI components:

my-app/
├── src/
│   ├── components/        # Layout components (GlobalHeader, MainNavigation, PageHeader, …)
│   ├── pages/
│   │   └── Home/
│   ├── App.tsx
│   ├── main.tsx
│   └── index.css
├── index.html
├── vite.config.ts
└── package.json

The following MFUI packages are installed automatically:

• @moneyforward/mfui-components
• @moneyforward/mfui-design-tokens
• @moneyforward/mfui-icons-react
• react-router-dom

Starting the generated app

cd my-app
npm run dev

All company names, product and service names, and logos are trademarks or registered trademarks of their respective owners.