Documentation Index
Fetch the complete documentation index at: https://mintlify.com/sammwyy/mikuMikuBeam/llms.txt
Use this file to discover all available pages before exploring further.
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
Install dependencies
Use the Makefile to install both Go and Node.js dependencies:This command runs:
go mod tidy- Downloads all Go module dependenciesnpm 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.
Configuration (optional)
Miku Miku Beam uses sensible defaults but can be customized with a TOML configuration file.Default configuration
Configuration options
| Option | Default | Description |
|---|---|---|
proxies_file | data/proxies.txt | Path to proxies list |
user_agents_file | data/uas.txt | Path to user agents list |
server_port | 3000 | Web server port |
allowed_origin | http://localhost:5173 | CORS allowed origin |
Using a config file
Verify installation
Verify that everything is installed correctly:- Help output from CLI and server binaries
- Three items in
bin/:mmb-cli,mmb-server, andweb-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”
Runmake 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