https://github.com/sopel-irc/sopel-help
Help plugin for Sopel
https://github.com/sopel-irc/sopel-help
Last synced: 7 months ago
JSON representation
Help plugin for Sopel
- Host: GitHub
- URL: https://github.com/sopel-irc/sopel-help
- Owner: sopel-irc
- License: other
- Created: 2020-01-10T17:53:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T17:32:52.000Z (8 months ago)
- Last Synced: 2024-10-22T07:55:56.242Z (8 months ago)
- Language: Python
- Size: 92.8 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
==========
sopel-help
==========
Sopel plugin ``.help`` command::
[Exirel]: .help help
[Sopel]: Generate help for Sopel's commands.
[Sopel]: e.g. .help help or .help
Install
=======
The recommanded way to install this plugin is to use ``pip``::
$ pip install sopel-help
Note that this plugin requires Python 3.8+ and Sopel 7.1+.
Configure
=========
As with many other plugins, you can use ``sopel-config`` to launch the
configuration wizard, like so::
$ sopel-plugins configure help
Don't forget to use the ``-c `` option to select the right config.
Providers
=========
There are several providers built-in with this plugin:
* ``base`` (the default): basic provider; it outputs help directly to the user
* ``local``: it generates an HTML file and outputs an URL; you have to
install and configure your own origin server to serve that file
* ``clbin``, ``0x0``, ``termbin``: all these providers post a plain-text file
to a pastebin service and then output the resulting URL