getting started

welcome to cleave. this guide will help you get the bot up and running in your server.

inviting the bot

click the invite button in the navigation bar. make sure to give cleave the necessary permissions for all features to work properly. we recommend administrator permission for full functionality.

recommended permissions
administrator
or
manage server, manage roles, manage channels,
ban members, kick members, manage messages,
moderate members, view channels, send messages,
embed links, attach files, add reactions

first steps

once cleave is in your server, run /help to see all available commands. start by setting up your server configuration using the setup commands.

setup guide

configure cleave to fit your server's needs. all setup commands require administrator permission.

moderation logging

set a channel where all moderation actions will be logged:

/setlog #mod-logs

this will log all bans, kicks, timeouts, warnings, and other mod actions.

welcome messages

set up automatic welcome messages for new members:

/setwelcome #welcome

auto role

automatically give new members a role when they join:

/setautorole @member

boost messages

celebrate server boosts:

/setboost #boost-logs

starboard

set up a starboard where starred messages appear:

/setstarboard #starboard 3

the number at the end is how many ⭐ reactions needed.

moderation

cleave has powerful moderation tools to keep your server clean and organized.

basic actions

  • /ban @user [reason] [days] - ban a member and optionally delete their messages
  • /unban [user_id] [reason] - unban a previously banned user
  • /kick @user [reason] - kick a member from the server
  • /timeout @user [duration] [reason] - temporarily mute a member

warnings

keep track of rule breakers with the warning system:

/warn @user stop spamming

view warnings with /warns @user and clear them with /clearwarns @user

advanced actions

  • /purge [amount] [@user] - bulk delete messages
  • /nuke - completely wipe a channel by cloning and deleting it
  • /softban @user - ban and immediately unban to clear messages
  • /hackban [user_id] - ban someone not in the server
  • /massban [ids] [reason] - ban multiple users at once

channel management

  • /lock [#channel] - prevent users from sending messages
  • /unlock [#channel] - allow users to send messages again
  • /hide [#channel] - hide channel from everyone
  • /unhide [#channel] - unhide channel
  • /slowmode [seconds] [#channel] - set message cooldown

time formats

when using timeout or other time-based commands, use these formats:

  • 10s - 10 seconds
  • 5m - 5 minutes
  • 2h - 2 hours
  • 1d - 1 day

economy system

cleave has a full economy system where users can earn, spend, and compete for money.

earning money

  • /work - work a job to earn $50-200
  • /crime - commit a crime for $200-500 (risky, might get fined)
  • /rob @user - attempt to rob another user

managing money

  • /balance [@user] - check your or someone's balance
  • /deposit [amount] - deposit money to bank (safe from robbery)
  • /withdraw [amount] - withdraw money from bank
  • /pay @user [amount] - give someone money

gambling

risk your money for a chance to double it:

/gamble 500

minimum bet is $50. you have a 50% chance to win.

leaderboard

see who the richest users in your server are:

/leaderboard

social features

cleave has features to help your community interact and build reputation.

vouch system

vouch for trustworthy users to build their reputation:

/vouch @user great trader, very trustworthy

check reputation with /rep @user

marriage system

marry someone in your server:

/marry @user

they'll need to accept by reacting to the message. divorce with /divorce

other features

  • /ship @user1 @user2 - calculate compatibility
  • /afk [reason] - set afk status

configuration

advanced configuration options for your server.

auto reactions

automatically react to all messages in a channel:

/autoreact #channel 🔥

counting channels

set up a counting game where users count sequentially:

/counting #counting

users can't count twice in a row. wrong numbers reset the count.

permissions

cleave respects discord's permission hierarchy.

permission levels

  • everyone - fun commands, utility, economy
  • manage messages - warns, say, embed
  • moderate members - timeout, untimeout, warn
  • kick members - kick
  • ban members - ban, unban, softban, hackban, massban
  • manage channels - lock, unlock, hide, unhide, slowmode, nuke
  • manage roles - role management
  • administrator - all config commands

role hierarchy

you can only moderate users below your highest role. cleave's role should be near the top for role management to work properly.

support

need help? we got you.

get support

  • join our discord server for live support
  • check the faq page for common questions
  • dm us on twitter for urgent issues

reporting bugs

found a bug? let us know in our discord server. please include:

  • what command you were using
  • what you expected to happen
  • what actually happened
  • screenshots if possible

feature requests

have an idea? we're always looking to improve. suggest features in our discord server.