maa-copilot(1)

💅 maa-copilot — the manual page, bestie edition

okay so real talk, maa-copilot is the maa subcommand that runs a copilot task, and this whole page is your cheat sheet. it's giving "general commands manual" energy, and yes it's literally the maa-copilot(1) page. let's get into it 🫶

---

✨ NAME ✨

maa-copilot — Run copilot task. that's it, that's the vibe. 💫

🌸 SYNOPSIS 🌸

maa copilot [--raid] [--formation] [--formation-index] [--add-trust]
[--ignore-requirements] [--use-sanity-potion] [--support-unit-usage]
[--support-unit-name] [--loop-times] [-a|--addr] [-p|--profile]
[--user-resource] [--dry-run] [--no-summary] [--no-auto-reconnect]
[--batch] [-v|--verbose]... [-q|--quiet]... [--log-file] [-h|--help]
[URI_LIST]

🦋 DESCRIPTION 🦋

Run copilot task. (yes, that's the whole description, and honestly? icon behavior. no cap.) ✨

---

🎀 OPTIONS 🎀

• --raid <RAID> [default: normal] — whether to fight the stage in raid mode, bestie.
  • normal for normal, raid for raid, both to run twice, once for both modes.
  • also accepts the legacy values 0, 1, and 2 (iykyk).
  • possible values, slay:
    • normal: Run the stage in normal mode only
    • raid: Run the stage in raid mode only
    • both: Run the stage twice, once in each mode
• --formation — Enable auto formation. 👑 here's the nuance though: when multiple uri are provided, or a copilot task set contains multiple stages, this gets forced to true. otherwise it defaults to false. the universe decides for you, periodt.
• --formation-index <FORMATION_INDEX> — Select which formation to use (1-4). if you don't provide it, we just use the current formation. simple as that 💅
• --add-trust — Fill empty slots by ascending trust value during auto formation. your low-trust faves get first dibs, that's so sweet actually 🥺
• --ignore-requirements — no description in the original, and I'm not about to invent one for you. it's a mystery, it's a vibe, it's staying that way. 🫣
• --use-sanity-potion — Use sanity potion to restore sanity when it's not enough. drink up bestie 🍓
• --support-unit-usage <SUPPORT_UNIT_USAGE> — Support operator usage mode. ⚠️ Effective only when formation is true. available modes:
  • 0: Do not use support operators (default).
  • 1: Use support operator only if exactly one operator is missing; otherwise, do not use support.
  • 2: Use support operator if one is missing; otherwise, use the specified one.
  • 3: Use support operator if one is missing; otherwise, use a random one.
• --support-unit-name <SUPPORT_UNIT_NAME> — Use given support unit name, don't use support unit if not provided. no name, no support, no exceptions. 💀
• --loop-times <LOOP_TIMES> — Loop times. run it back, run it back, run it back 🔥
• -a, --addr <ADDR> — ADB serial number of device or MaaTools address set in PlayCover. 🧚 by default, MaaCore connects to 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 and then you can specify the address of MaaTools here. whole thing, no skips.
• -p, --profile <PROFILE> — Profile (asst config file) name. 🎀 a profile is a config file that contains the configuration passed to MaaCore. by default, we will try to load the config file $MAA_CONFIG_DIR/profiles/default.toml. if the file does not exist, we will try to load the config file $MAA_CONFIG_DIR/asst.toml for backward compatibility, which is the old config file name. if you want to use another config file, you can specify the profile name here. the config file should be placed in the directory $MAA_CONFIG_DIR/profiles/. got all that? 💖
• --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 you want to use your own resources, you can 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! ⚠️ like, genuinely, the last one in wins and that's a little scary.

• --dry-run — Parse the your config but do not connect to the game. (typo is canon, we respect the original 🫡) this option 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. it's giving "rehearsal before the performance" ✨
• --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, you can use this option. no recap for you then 🙈
• --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. one-time setting, not forever, bestie 💅
• --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 questions, just defaults, main character energy 🔥
• -v, --verbose — Increase verbosity, repeat for more verbosity. stack it like accessories 🎀
• -q, --quiet — Decrease verbosity, repeat for more quiet. shhh 🤫
• --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. timestamped and everything, obsessed ⭐
• -h, --help — Print help (see a summary with -h). the classic 🫶
• [URI_LIST] — URI of the copilot task file. 💜 it can be a maa URI or a local file path. multiple URIs can be provided to fight multiple stages. for URI, it can be in the format of maa://<code>, maa://<code>s, file://<path>, which represents a single copilot task, a copilot task set, and a local file respectively, where file:// prefix can be omitted. so many formats, all valid, all iconic 🌸

---

🧚 sign-off 🧚

that's the whole page, bestie — every flag, every default, every warning, nothing skipped. signed, sealed, delivered by copilot and this very maa-copilot(1) page. stay hydrated and don't forget --dry-run 💖✨🦋