Quickstart

copied

Install Nimbella Commander

copied

You can install directly by clicking here: Add Commander to Microsoft Teams

To complete the tutorial and create your own commands, you must have permission to install an app in Microsoft Teams. If you are Teams admin, you should have that permission. If you can't, you will need to contact your Teams admin to get permission to install Commander in Teams.

Test the installation

copied

Run "@commander take a tour" in any Teams channel. This will invoke Commander and execute "take a tour" command.

In order to chat with Commander bot privately, go to chat, click on the edit button, add Commander and then type "take a tour". When interacting with Commander bot privately, you don't need to type @commander for every command.

Tutorial 1: Create your first command

copied

Let's create a command. We'll explain these steps later on.

  1. Click on the Commander bot in Chat to interact with Commander.
  2. Create a print command

Commander User
User 8:07 PM
command create print 
Commander Admin
Commander App 8:07 PM

Created command print  , edit the code

  1. Change the source code for the print command to print the message by clicking on edit the code link

edit the code

  1. Run the print command you just created. You can click on the run print button or type run print
    Commander User
    User 8:07 PM
    run print 
    Commander Admin
    Commander App 8:07 PM

    This is a default response for a newly created command with text: print

  2. Ask Commander to list all custom commands
    Commander User
    User 8:07 PM
    command list 
  3. Show a log of the print command you created
    Commander User
    User 8:07 PM
    command log print 
  4. Allow another user to run the print command. The commands for allowing access control to other users can only be executed in public channels. You will need to prefix the commands with @commander to run commands in public channels. (Refer: Ways to interact with Commander)
    Commander User
    User 8:07 PM
    @commander command runners print + @user 

Tutorial 2: Install a Command Set

copied

Sets of commands can be installed using a command set manager (csm) command.

  1. Install the dig command set
    Commander User
    User 8:07 PM
    csm install dig 
  2. Run the dig command. It is part of the dig command set you just installed.
    Commander User
    User 8:07 PM
    run dig yahoo.com 

Ways to interact with Commander

copied

  1. Using Commander in Public Channels

You can use Commander in Microsoft Teams in public channels by typing @commander and then a command. For example:

@commander run print

When you type @commander and press space, the @ sign should appear and "Commander" should change to a blue color. If it doesn't, then you likely have a channel or other name in Microsoft Teams that starts with the word "Commander".

Correct use: If you use @ to direct a message at someone in Microsoft teams, it will automatically set the recipient if you type the full name of that person or bot and then press space but only if that name is unique. (see below)

Incorrect use: If you type the full word "@commander" and a list with more than one option is present at the end and you press space, Teams will not automatically select an option for you and the @commander will appear with the @ sign, in its original color, and the command you type won't end up being sent to Commander (see below)

Because of this, in a public channel, it is best to start typing @commander and then hit Enter and select the Commander bot from the list that pops up to direct a message to Commander. This ensures the message will be directed at Commander in any case.

  1. Privately Chatting with Commander

You can also message the Commander bot directly in Chat. When interacting with Commander bot, you don't need to prefix a command with @commander, you can simply type the command.

If you are creating a command with parameters in the private Commander channel, you need to press Shift-Enter to create the command. Just pressing Enter will not create the command with parameters. This is not a bug but it is Microsoft Teams behavior. This is not required when creating commands in pubic channels.

  1. Using Commander in other Private Channels

Microsoft Teams does not support communicating with bots in a private channel that is not the bot's channel. Because of this, you can't issue a Commander command in a private channel that is between you and someone else.