lita-cmd

Run scripts from your lita machine and get the output back.

Add lita-cmd to your Lita instance's Gemfile:

gem "lita-cmd"

Lita.configure do |config|
  # Lita CMD - required parameters
  config.handlers.cmd.scripts_dir = "/path/to/dir/you/expose"

  # Lita CMD - optional parameters

  # Set the output format. Default: "%s"
  # Note that %s will contain the returned text
  config.handlers.cmd.output_format = "/code %s"

  # Set the prefix of stdout and stderr.
  config.handlers.cmd.stdout_prefix = ""
  config.handlers.cmd.stderr_prefix = "ERROR: "

  # Set the prefix for running scripts.
  config.handlers.cmd.command_prefix = "run "

  # Set the characters that, if present, will cause a file to not be flagged as a script
  config.handlers.cmd.ignore_script = Regexp.union(/~/, /#/)

end

In your chatroom, try one of these commands

Query the configured directory for filenames and return the list

Execute a file in the configured directory

Scripts can be passed in options that contain spaces by surrounding with double quotes

You can control what groups have access to your Lita scripts.

In your scripts directory make a sub directory named after each of your groups. Only users that belong to these groups can list and execute the scripts inside them.

This is the basic directory structure

scripts/
  |- devops/
  |  - secret_script
  |- script1
  |- script2

When you run lita cmd list you will only see scripts that you have access to. For example:

me:   lita cmd list

lita: devops/secret_script
      script1
      script2

me:   lita cmd devops/secret_script

lita: Executing the secret script

You the option of specifying environment variables to the script that are populated by Redis keys. The namespace of this lita handler is lita:handlers:cmd. Underneath that namespace you can set users and global envvars.

Example

See the following script:

#!/bin/bash

echo "My var: ${MY_VAR}"
echo "Global var: ${GLOBAL_VAR}"

Set the following keys:

redis-cli set 'lita:handlers:cmd:@global_var' 'I'm global!'
redis-cli set 'lita:handlers:cmd:user1:my_var' 'I'm user #1'
redis-cli set 'lita:handlers:cmd:user2:my_var' 'I'm user #2'

When User1 runs she script, she'll see the following:

My var: I'm user #1
Global var: I'm global!

Similarly, User2 will see:

My var: I'm user #2
Global var: I'm global!

Go into your Redis machine and set lita:handlers:cmd:{{username}}:{{key name}}. That key will be presented to all of the scripts that the user runs.

Set lita:handlers:cmd:@test_var. This will be presented to all of your scripts as TEST_VAR={{value}}.

• The user name of the calling user will be saved in an environment variable called LITA_USER.
• Make sure that your files are executables (chmod +x FILE)
• Make sure that your files have the proper sheband (#!/bin/bash)

• Add tests