``sysadmin`` commands
=====================

.. csv-table::
  :widths: auto

  "**Plugin**", :class:`~shellbot.plugins.sysadmin.Sysadmin`
  "**Brief**", "Administration commands."


`ban <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.ban>`_
------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Ban the mentioned user and, optionnally, delete their message."
  "**Usage**", ``ban [--ndays NDAYS] [user]``

.. code-block:: text

        positional arguments:
          user           an optional user mention or the Discord user's id

        optional arguments:
          --ndays NDAYS  delete messages in the previous NDAYS days. Defaults to 0


Examples
~~~~~~~~

.. csv-table::
    :widths: auto

    "``ban``","Show banned users."
    "``ban <user mention>``","Attempt to ban the mentioned user."
    "``ban <user mention> --ndays 3``","Attempt to ban the mentioned user and delete their 3-previous days messages."

`chgroup <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.chgroup>`_
--------------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Change permissions group for the mentioned user."
  "**Usage**", ``chgroup mention primary_key``

.. code-block:: text

        positional arguments:
          mention      a mention of the user to change
          primary_key  a valid role primary key or a group


Details
~~~~~~~

.. _GUEST:

GUEST group (0)
"""""""""""""""
Interaction with the bot is disabled and cannot be self-enabled.
The bot will completely ignore any commands coming from such a member.


.. _USER:

USER group (1)
""""""""""""""
Default group for any server's member.


.. _ORDINAL:

ORDINAL group (2)
"""""""""""""""""
Members in this group are allowed to use the following commands:

+--------------+------------------------+
| Plugin       | Commands               |
+==============+========================+
| `core`_      | **debug**              |
+--------------+------------------------+
| `sysadmin`_  | **mute**, **chgroup**  |
+--------------+------------------------+
| `audio`_     | **vjoin**, **vquit**   |
+--------------+------------------------+

.. _ADMIN:

ADMIN group (3)
"""""""""""""""
Inherits permissions from `ORDINAL`_ group. Furthermore, members in this group
have permissions to change the group of an user with lower permissions and can
execute the following commands from the `core`_ plugin.

* **announce**, **chmod**, **config**, **goodbye**, **welcome**


.. _ONWER:

OWNER group (4)
"""""""""""""""
Group created for conveniance and automatically assigned to server's owner.


Custom roles
""""""""""""
Custom roles may inherit default groups and thus it is possible to change their
default behaviour. The GID of the customized role is the same as its parent
but its UID must be different in order to distinguish between them.

.. _core: ../commands/core.html
.. _sysadmin: ../commands/sysadmin.html
.. _audio: ../commands/audio.html

`group <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.group>`_
----------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "gid"
  "**Brief**", "Show the group the user belongs to."
  "**Usage**", ``group [mention]``

.. code-block:: text

        positional arguments:
          mention  an optional user mention


Examples
~~~~~~~~

.. csv-table::
    :widths: auto

    "``group``","Show the group the user belongs to."
    "``group <user mention>``","Show the group the mentioned user belongs to."

`groupmod <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.groupmod>`_
----------------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "gmod"
  "**Brief**", "Groups and roles manager."
  "**Usage**", ``groupmod action primary_key``

.. code-block:: text

        positional arguments:
          action       method 'POST', 'PATCH', 'DELETE' or 'GET'
          primary_key  a valid role primary key or a group


`invite <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.invite>`_
------------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Create a server invite URL."
  "**Usage**", ``invite``



`kick <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.kick>`_
--------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Kick the mentioned user."
  "**Usage**", ``kick user``

.. code-block:: text

        positional arguments:
          user  an user mention


`serverinfo <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.serverinfo>`_
--------------------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "servinfo"
  "**Brief**", "Show public data for the server."
  "**Usage**", ``serverinfo``



`unban <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.unban>`_
----------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Unban the UNIQUE specific user with correct ID."
  "**Usage**", ``unban user_id``

.. code-block:: text

        positional arguments:
          user_id


Examples
~~~~~~~~

.. csv-table::
    :widths: auto

    "``unban 31419265``","Unban the UNIQUE user whose ID is `31419265`. The latter has to be present in the blacklist."

`whois <../plugins/sysadmin.html#shellbot.plugins.sysadmin.Sysadmin.whois>`_
----------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Show public data for self or mentioned user."
  "**Usage**", ``whois [mention]``

.. code-block:: text

        positional arguments:
          mention  an optional user mention


Examples
~~~~~~~~

.. csv-table::
    :widths: auto

    "``whois``","Show self public data."
    "``whois <user mention>``","Show public data for the mentioned user."