PaulCLI logoPaulCLI

Settings reference

WelcomeConfig fields, defaults, variables, and extras.

SettingTypeDefaultWhat it does
welcomeEnabledbooleanfalseEnables the join message.
welcomeChannelIdsnowflake or nullnullChannel used for welcome messages. Required for sending.
welcomeMessagestringWelcome {user} to **{server}**! You are member #{memberCount}.Template sent when a member joins.
welcomeStyleTEXT | EMBED | V2 | CANVASTEXTRenderer used for welcome messages.
welcomeExtrasJSON object string{}Style-specific settings for welcome messages.
goodbyeEnabledbooleanfalseEnables the leave message.
goodbyeChannelIdsnowflake or nullnullChannel used for goodbye messages. Required for sending.
goodbyeMessagestring**{user}** has left **{server}**.Template sent when a member leaves.
goodbyeStyleTEXT | EMBED | V2 | CANVASTEXTRenderer used for goodbye messages.
goodbyeExtrasJSON object string{}Style-specific settings for goodbye messages.
{user}
Join: member mention. Leave: plain username.
{username}
Display name if available, otherwise username.
{userTag}
Username from Discord user data.
{userId}
Discord user ID.
{avatar}
Member avatar URL at size 256, or empty string.
{server}
Server name.
{serverId}
Discord guild ID.
{memberCount}
Current guild member count.
{ordinal}
Member count with suffix, such as 1st, 42nd, or 113th.
{createdAt}
Relative Discord timestamp for account creation, or unknown.
{joinedAt}
Relative Discord timestamp for join time, or current time when unavailable.

Extras accepted by the API include title, color, showAvatar, imageUrl, footer, V2-only thumbnailUrl, spoiler, divider, spacing, images up to 10, links up to 3, and CANVAS-only cardTitle, cardSubtitle, cardBg1, cardBg2, and cardAccent. Hex colors must be #rrggbb.