Flags - mira

Some commands take optional named settings on top of their normal arguments. These are flags, and they always go at the end.

!antinuke ban on --threshold 3 --duration 1h

Three ways to write them

All of these are identical:

!antinuke ban on --threshold 3

!antinuke ban on -threshold 3

!antinuke ban on threshold: 3

The colon form is the most readable when you’re passing several, and it’s the one that survives phone autocorrect turning -- into an em dash. (An em dash is normalised back to -- anyway, so —threshold 3 also works.)

Boolean flags

Flags that take a yes/no value default to true when you leave the value off:

!purge tos --tos

!purge tos --tos true
!purge tos --tos false

Values with spaces

Quote them:

!ban list --reason "coordinated raid"

Aliases

Most flags have short forms. The command’s help page lists them:

!help antinuke ban

For example, antinuke’s --threshold also answers to --limit, and --duration answers to --time and --per:

!antinuke ban on --limit 3 --per 1h

Commonly used flags

Antinuke

Flag	Aliases	Default	Range
`--threshold`	`limit`	`3`	1–12
`--duration`	`time`, `per`	`1h`	up to 12h

On webhookspam:

Flag	Default	Range
`--mentions`	`20`	5–100
`--everyone`	`1`	0–5

Antiraid

Flag	Aliases	Applies to
`--punishment`	`action`, `punish`, `do`, `p`, `a`	Every module
`--threshold`	`count`, `amount`, `t`	Most modules
`--for`	`time`, `duration`, `l`	`spam` — timeout length
`--messages`	`count`, `msgs`, `m`	`raidspam`
`--users`	`members`, `unique`, `u`	`raidspam` threshold

!antiraid spam on 5s --threshold 8 --punishment timeout --for 10m

Starboard

Flag	Aliases	Default
`--threshold`	`limit`	`3`
`--self`	`self_star`	`true`
`--color`	`colour`	`member`
`--timestamp`	`time`	`true`

!starboard add #starboard ⭐ --threshold 5 --self false --color member

Honeypot

Flag	Aliases	Default
`--punishment`	`action`	`softban`
`--dm`	`send_dm`, `notify`	`true`
`--boosters`	`boosts`	`false`
`--warmer`	`active`, `alive`	`true`
`--random`	`names`	`false`
`--string`	`random_string`	`false`

Bans

Flag	Aliases
`--duration`	`expiration`, `exp`, `time`, `until`, `for`
`--reason`	`r`
`--moderator`	`mod`, `by`, `staff`

The last two filter ban list:

!ban list --reason raid --moderator @jake

Silent punishments

Not a flag exactly, but it works the same way — adding -s or --silent to a reason suppresses the DM to the punished member:

!ban @someone raiding -s

Finding a command’s flags

!help <command>

The help page lists every flag with its aliases, default and accepted values. If a command doesn’t list any, it doesn’t take any.

​Three ways to write them

​Boolean flags

​Values with spaces

​Aliases

​Commonly used flags

​Silent punishments

​Finding a command’s flags