9.9 KiB
Commands
- Command interpreter
- Types of commands
- List of commands
Command interpreter
PBot has a powerful command interpreter with useful functionality.
Piping
You can pipe output from one command as input into another command, indefinitely.
<pragma-> !echo hello world | {sed s/world/everybody/} | {uc}
<PBot> HELLO EVERYBODYSubstitution
You can insert the output from another command at any point within a command. This substitutes the command with its output at the point where the command was used.
<pragma-> !echo This is &{echo a demonstration} of command substitution
<PBot> This is a demonstration of command substitutionFor example, suppose you want to make a Google Image Search command. The naive way would be to simply do:
<pragma-> !factadd img /call echo https://google.com/search?tbm=isch&q=$argsUnfortuately this would not support queries containing spaces or
certain symbols. But never fear! We can use command substitution and the
uri_escape function from the func command.
Note that you must escape the command substitution to insert it literally into the factoid otherwise it will be expanded first.
<pragma-> !factadd img /call echo https://google.com/search?tbm=isch&q=\&{func uri_escape $args}
<pragma-> !img spaces & stuff
<PBot> https://google.com/search?tbm=isch&q=spaces%20%26%20stuffChaining
You can execute multiple commands sequentially as one command.
<pragma-> !echo Test! ;;; me smiles. ;;; version
<PBot> Test! * PBot smiles. PBot version 2696 2020-01-04Variables
You can use factoids as variables and interpolate them within commands.
<pragma-> !factadd greeting "Hello, world"
<pragma-> !echo greeting is $greeting
<PBot> greeting is Hello, worldPBot variable interpolation supports expansion modifiers, which can be chained to combine their effects.
<pragma-> !echo $greeting:uc
<PBot> HELLO, WORLDInline invocation
You can invoke up to three commands inlined within a message. If the message is addressed to a nick, the output will also be addressed to them.
<pragma-> newuser13: Check the !{version} and the !{help} documentation.
<PBot> newuser13: PBot version 2696 2020-01-04
<PBot> newuser13: To learn all about me, see https://github.com/pragma-/pbot/tree/master/docTypes of commands
There are several ways of adding new commands to PBot. We’ll go over them here.
Built-in commands
Built-in commands are commands that are internal and native to PBot. They are executed within PBot’s API and context. They have access to PBot internal subroutine and data structures.
Creating new built-in commands
Built-in commands are created via the register()
function of the Commands module. Such commands are
registered throughout PBot’s source code. The owner of the PBot instance
can locally add new commands by editing PBot’s source code or by
acquiring and loading Plugins.
Plugins
Additional built-in commands can be created by loading PBot Plugins. Plugins are stand-alone self-contained units of code that can be loaded by the PBot owner.
Plugins have access to PBot’s internal APIs and data structures.
Factoids
Factoids are another type of command. Factoids are simple textual
strings that anybody can create. At their most simple, they display
their text when invoked. However, significantly more complex Factoids
can be created by using the powerful interpreter and by using the even
more powerful /code Factoid command.
Factoids do not have access to PBot’s internal API or data structures.
Code Factoids
Code Factoids are Factoids whose text begins with the
/code command. These Factoids will execute their text using
the scripting or programming language specified by the
/code command.
Code Factoids do not have access to PBot’s internal API or data structures.
Modules
Modules are simple stand-alone external command-line scripts and programs. Just about any application that can be run in your command-line shell can be loaded as a PBot module.
Modules do not have access to PBot’s internal API or data structures.
List of commands
Here is the list of all of PBot’s built-in commands and some of the more useful Factoids, Plugins and Modules.