Skip to main content

Prerequisites

Before installing Miku Miku Beam, ensure you have the following tools installed:

Go

Version 1.21 or above

Node.js

Version 18 or above

npm

Node Package Manager
The project uses Go 1.24.5 in the source code. Any Go version 1.21+ should work, but newer versions are recommended.

Installation steps

1

Clone the repository

Clone the Miku Miku Beam repository from GitHub:
2

Install dependencies

Use the Makefile to install both Go and Node.js dependencies:
This command runs:
  • go mod tidy - Downloads all Go module dependencies
  • npm install - Installs Node.js packages for the web client
If you encounter “module not found” errors, ensure you’re in the project root directory and have internet connectivity.
3

Create required data files

Create the data directory and required configuration files:

Proxies file (data/proxies.txt)

Add one proxy per line in any of these formats:
If no proxies are configured, you must use the --no-proxy flag in CLI or set ALLOW_NO_PROXY=true for the server.

User agents file (data/uas.txt)

Add one user agent string per line:
4

Build the project

Build all components (web client, CLI, and server):
This creates:
  • bin/mmb-cli - Command-line interface binary
  • bin/mmb-server - Web server binary
  • bin/web-client/ - Built React frontend
You can build individual components using make cli, make server, or make webclient.

Configuration (optional)

Miku Miku Beam uses sensible defaults but can be customized with a TOML configuration file.

Default configuration

Configuration options

Using a config file

Verify installation

Verify that everything is installed correctly:
You should see:
  • Help output from CLI and server binaries
  • Three items in bin/: mmb-cli, mmb-server, and web-client/

Makefile commands reference

The project includes helpful Makefile commands:

Troubleshooting

”concurrently” error on startup

This is a Node.js/React issue. Ensure you have Node.js v18+ installed and run:

Build fails with “module not found”

Run make prepare to download all dependencies:

Web client doesn’t load

Make sure you’ve built the web client before starting the server:

Next steps

Quick start

Run your first attack and explore the interface