diff options
author | href <href@random.sh> | 2021-09-01 11:54:53 +0200 |
---|---|---|
committer | href <href@random.sh> | 2021-09-01 11:54:53 +0200 |
commit | 24ac982428de355eedcf834035139a6c5885bd78 (patch) | |
tree | 82c1f2fa3f7ce6b606b226dd8685c64f79d839fc /Admin.md | |
parent | broadcast,np: remove as it is now totally useless (diff) |
Small readme update + Admin cli
Diffstat (limited to '')
-rw-r--r-- | Admin.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/Admin.md b/Admin.md new file mode 100644 index 0000000..0724ab8 --- /dev/null +++ b/Admin.md @@ -0,0 +1,42 @@ +# ircbot admin bot + +Everything is supposed to be ran inside a remote IEx console: `./bin/lsg remote`. + +## Connection management + +### List Connections + + IRC.Connection.connections() + +### Add Connection + + conn = %{nick: "nick", user: "user", name: "user", network: "netname", host: "irc.netname.org", tls: true, port: 6697} + IRC.Connection.add_connection(conn) + +### Start Connection + + IRC.Connection.start_connection(connection_id) + +### Stop Connection + + IRC.Connection.stop_connection(connection_id) + +### Delete Connection + + IRC.Connection.delete_connection(connection_id) + +## Plugin management + +### Enabled plugins + + IRC.Plugin.enabled() + +### Enable or Disable a plugin + + IRC.Plugin.disable(plugin_module_or_name) + IRC.Plugin.enable(plugin_module_or_name) + IRC.Plugin.switch(plugin_module_or_name) + +### Declare a plugin + + IRC.Plugin.declare(module) |