maa-run(1)

💖 NAME 💖

maa-run — run a custom task, bestie. This is the maa-run(1) page from the General Commands Manual, and yes we’re gonna make it make sense. periodt.

✨ SYNOPSIS ✨

maa run [-a|--addr] [-p|--profile] [--user-resource] [--dry-run]
[--no-summary] [--no-auto-reconnect] [--batch] [-v|--verbose]...
[-q|--quiet]... [--log-file] [-h|--help] <TASK>

🌸 DESCRIPTION 🌸

okay so maa-run runs a custom task. All arguments will be passed to maa-run, so type --help if you want more information, iykyk.

Your task is defined in the config directory of maa-cli. Use maa dir config to get the path of the config directory, then create a directory named tasks in it. Inside that tasks directory, create a TOML or JSON file to define a task. More information can be found in the README. You can also use maa-cli list to list all available tasks. slay.

💅 OPTIONS 💅

• -a, --addr <ADDR> — ADB serial number of device, or MaaTools address set in PlayCover. By default, MaaCore connects to the game with ADB, and this parameter is the serial number of the device (default to emulator-5554 if not specified here and not set in config file). And if you want to use PlayCover, you need to set the connection type to PlayCover in the config file, then you can specify the address of MaaTools here.
• -p, --profile <PROFILE> — profile (asst config file) name. A profile is a config file that contains the configuration passed to MaaCore. By default, we try to load $MAA_CONFIG_DIR/profiles/default.toml. If that file does not exist, we try to load $MAA_CONFIG_DIR/asst.toml for backward compatibility — that’s the old config file name. If you want another config file, specify the profile name here. The config file should live in $MAA_CONFIG_DIR/profiles/.
• --user-resource — load resources from the config directory. By default, MaaCore loads resources from the resource installed with MaaCore. If you want to modify some configuration of MaaCore or use your own resources, use this option to load resources from the resource directory, which is a subdirectory of the config directory. This option can also be enabled by setting the value of the key user_resource to true in the asst configure file $MAA_CONFIG_DIR/asst.toml.

Note: CLI will load resources shipped with MaaCore firstly, then some client specific or platform specific when needed, lastly, it will load resources from the config directory. MaaCore will overwrite the resources loaded before, if there are some resources with the same name. Use at your own risk! 💀

• --dry-run — parse your config but do not connect to the game. This is useful when you want to check your config file. It will parse your config file and set the log level to debug. If there are some errors in your config file, it will print the error message and exit. so handy.
• --no-summary — do not display task summary. By default, maa will display task summary after all tasks are finished. If you want to disable this behavior, use this option.
• --no-auto-reconnect — do not reconnect when game loses connection to server. By default, maa will automatically reconnect when the game client loses connection to the game server. Use this option to disable this behavior for this run.
• --batch — enable batch mode. If there are some input parameters in the task file, some prompts will be displayed to ask for input. In batch mode, the prompts will be skipped, and parameters will be set to default values. no cap, very set-it-and-forget-it.
• -v, --verbose — increase verbosity, repeat for more verbosity.
• -q, --quiet — decrease verbosity, repeat for more quiet.
• --log-file[=<PATH>] — redirect log to file instead of stderr. If no log file is specified, the log will be written to $(maa dir log)/YYYY/MM/DD/HH:MM:SS.log.
• -h, --help — print help (see a summary with -h).
• <TASK> — name of the task to run. The task name is the name of the task file without the extension. The task file must be in the tasks directory of the config directory. The task file must be in the TOML, YAML or JSON format.

---

💋 mwah! Cute little footer sign-off: the footer’s source/version/manual bits are run and maa-run(1), and no separate date line was printed in this footer — so that’s the whole tea, bestie. 🫶