Skip to content

@token bot cheat sheet

Charlie Brummitt edited this page Apr 28, 2017 · 4 revisions

How to use the @token bot

Basic commands

In the commands below, replace @user by the user name of someone, such as @Barack.Obama.

Command What the bot does
/give @user gives one of your tokens to @user
/status shows the status of your tokens (given and received)
/status @user shows the status of someone else's tokens (given and received)
/leaderboard lists the 10 people who hold the most tokens from other people
/who has tokens to give list users with tokens available to give to others

Where do I give the bot commands?

Enter each command either

  • in any public channel
  • or in a direct message to the bot @token.

A channel in Rocket.Chat is public if its name in the list of CHANNELS looks like #channel-name:

Example of public and private channels Example of direct message with the token bot

Where does the bot respond to my command?

  • In the same channel for the commands /give @user and /revoke @user; and
  • In a direct message for the commands /status, /leaderboard, and /who has tokens to give. (Because these commands contain many mentions of other users, the bot responds privately so that other users are not overwhelmed with notifications.)

How do I write a command?

All commands begin with a forward slash /. The / tells the bot listen up!

Pro tip: If you write the command in a direct message to /@token rather than in a public channel, then the bot is already listening, so the / is optional. For example, in a direct message you can write status or /status; in a public channel you must write /status.

If I give or revoke a token, does the recipient get notified?

Only if you do the command in a public channel.

Advanced commands

Giving and revoking multiple tokens at a time

Advanced command What the bot does
/give 2 @user gives two tokens to @user
/give all @user gives all your remaining tokens to @user

Change the size of the leaderboard

The /leaderboard command shows the 10 users with the most tokens given by other people. You can change the size of the leaderboard using the command /show top n list where n is a number:

Advanced command What the bot does
/show top 20 list shows the top 20 users with the most tokens given by others

(You can write any number instead of 20.)

Examples

Giving tokens

Give one token

Write /give followed by a space followed by someone's user name such as @Barack.Obama. Rocket.Chat can automatically complete someone's user name as you type it.

Example of giving one token

Give multiple tokens

Write a number between /give and @user_name. The number of tokens can be a number such as 3 or three or the keyword all, which gives all your remaining tokens.

Example of giving multiple tokens

Trying to /give but you don't have any tokens left

If you don't have any more tokens to give, then the bot will respond with a message like this:

Error message for giving tokens when you do not have any tokens to give

Status

Get the status of yourself using /status:

Status of oneself

Get the status of someone else using /status @user:

Status of someone else

Leaderboard

Show the leaderboard of the top 10 people who currently hold the most tokens given by others:

Leaderboard example

Control the size of the leaderboard

Want to show a larger or smaller leaderboard? Enter a command like the following:

Example of show top n list