https://github.com/opsdroid/skill-help

💬 A skill to provide help for opsdroid
https://github.com/opsdroid/skill-help

Last synced: 3 months ago
JSON representation

💬 A skill to provide help for opsdroid

• Host: GitHub
• URL: https://github.com/opsdroid/skill-help
• Owner: opsdroid
• License: apache-2.0
• Created: 2018-01-15T17:28:40.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-08T08:29:16.000Z (about 5 years ago)
• Last Synced: 2024-04-14T00:59:13.696Z (7 months ago)
• Language: Python
• Size: 9.77 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# opsdroid skill help

A skill for [opsdroid](https://github.com/opsdroid/opsdroid) to respond with help strings from loaded skills.

## Requirements

None.

## Configuration

None.

## Usage

#### `help`

Replies with all doc strings from loaded skill functions.

> user: help

>

> opsdroid:

help: help - Displays this help message

help_skill: help  - Displays usage for provided skill

#### `help `

Replies with the doc string for provided skill.

> user: help help

>

> opsdroid: help - Displays this help message

## Add your skill to the help output

Add a [docstring](https://www.python.org/dev/peps/pep-0257/) to your skill. The format is: skill usage, `-`, and a description of the skill.

```

skill_name  [optional_parameter] - Description of the skill

```

The usage should follow the [docopt](http://docopt.org/) format.