Jarvis User Manual

alert

Make a reminder for your future self.

Usage: !alert {set,echo}

Arguments:

mode

Name of the subcommand to execute.

echo

Output existing alerts.

Usage: !alert echo

set

Set a new alert.

Usage: !alert set (date|span) message

Arguments:

date

Date in YYYY-MM-DD format.

span

Time to wait before the alert, for example 2d3h4m.

message

Alert text.

author

Display author summary.

authordetails

Generate detailed statistics about the author.

choose

Return one random comma-separated option.

cleantitles

Remove orphaned scp titles from the series pages.

Staff-only command.

configure

Change the state of a configurable parameter.

Usage: !configure {memos,lcratings,keeplogs,urbandict,gibber}

Arguments:

mode

Name of the subcommand to execute.

gibber

Enable or disable the .gibber command.

Usage: !configure gibber [value]

Arguments:

value

New value of the configured parameter.

keeplogs

Toggle log keeping for this channel.

Disabling logs will break .seen and any other commands relying on logs.

Usage: !configure keeplogs [value]

Arguments:

value

New value of the configured parameter.

lcratings

Toggle lcratings setting for this channel.

Determines whether article ratings will be displayed by the .lc command.

Defaults to 'on'.

Usage: !configure lcratings [value]

Arguments:

value

New value of the configured parameter.

memos

Toggle memo settings for this channel.

Possible values is 'off', 'alphanumeric', and 'all'.

'off' will disable memos and quotes in the channel.

'alphanumeric' limits possible usernames in memos and quotes to alphanumeric characters, preventing lines such as '???' from being interpreted as memo pull up requests.

'all' allows unrestricted memo use.

Defaults to 'all'. Can only be changed by channel operators.

Usage: !configure memos [value]

Arguments:

value

New value of the configured parameter.

urbandict

Enable or disable the use of .urbandictionary in the channel.

Usage: !configure urbandict [value]

Arguments:

value

New value of the configured parameter.

contest

Display information about past contests.

Usage: !contest [name] [year]

Arguments:

name

Find contests by partial or full name.

year

Find contests run in the given year.

convert

Convert between different measurement units.

The full list of supported units can be found here: https://github.com/hgrecco/pint/blob/master/pint/default_en_0.6.txt

Usage: !convert expression [--precision [precision]]

Arguments:

expression

Conversion expression. Must follow the form of "<number> <unit> to <unit>".

--precision, -p

Specify conversion precision. By default .convert will attempt to preserve the significant figures of the input value. This parameter overrides the default behaviour. Positive precision values correspond to the number of digits displayed after the decimal point. Negative precision values will round the result value to the nearest ten, hundred, thousand, etc.

dice

Return the result of rolling multiple dice.

Examples of valid dice throws: 2d5 d100 -10d5 +3d20 3d20 +5 open the door 3df 2d2

Usage: !dice throws [bonus] [text] [--expand]

Arguments:

throws

One or more dice throws to be calculated.

bonus

Bonus value to be added to or substracted from the final result.

text

Description of the throw.

--expand, -e

Display detailed information about each thrown die.

dictionary

Look up dictionary definition of a word or a phrase.

Usage: !dictionary query

Arguments:

query

A word or a phrase.

duckduckgo

Ask the ducks if they know anything about the topic.

Usage: !duckduckgo query [--index index]

Arguments:

query

Your search query.

--index, -i

Number of the result to show, between 1 and 30.

errors

Dispay an error report.

Staff-only command.

gibber

Generate a message using markov chains, hatbot-like.

If the user isn't specified, generates the message based on the log of the entire channel.

Usage: !gibber [channel] [user] [--quotes]

Arguments:

channel

Switch to another channel.

user

What would <user> say?

--quotes, -q

Use quotes instead of history as source of the gib.

gis

Search for images.

Usage: !gis query [--index index]

Arguments:

query

Your search query.

--index, -i

Number of the result to show, between 1 and 10.

google

Ask the wise and all-knowing Google.

Usage: !google query [--index index]

Arguments:

query

Your search query.

--index, -i

Number of the result to show, between 1 and 10.

hugs

Who's a good bot? Jarvy is a good bot.

images

Image Team magic toolkit.

Usage: !images {scan,update,list,notes,purge,search,stats,sync,add,remove,attribute,claim,tagcc}

Arguments:

mode

Name of the subcommand to execute.

add

Add image to the index.

This subcommand is to be used when only when 'scan' is not applicable, such as in situation where the image have been taken down from the page before being added to the index.

If the image is properly uploaded to the page, jarvis should be able to determine the page it belongs to based solely on image url. Otherwise, name of the image's parent page must be supplied.

Usage: !images add url [page]

Arguments:

url

Full url of the image.

page

Name of the parent page.

attribute

Attribute page images.

Jarvis will make a post in the page's discussion thread, attributing all applicable indexed images found on the page to their respective sources. The text of the attributions is based on the license of the image. Public Domain images are not attributed.

Usage: !images attribute page

Arguments:

page

Name of the page to be attributed.

claim

Reserve image category.

Adds a note on the index page indicating that the particular image category is being reviewed by the specific user.

Usage: !images claim category [--purge]

Arguments:

category

Name of the category.

--purge, -p

Delete claim.

list

Display image records.

Usage: !images list target [index] [--terse]

Arguments:

target

Page name or image url indicating which image to target.

index

For pages with multiple images, index specifies which image to use.

--terse, -t

Do not show full urls.

notes

Add, change, remove, or display image notes.

Usage: !images notes target [index] [--append append|--purge|--list]

Arguments:

target

Page name or image url indicating which image to target.

index

For pages with multiple images, index specifies which image to use.

--append, -a

Add a new note to the image.

--purge, -p

Delete all notes from the record.

--list, -l

Display all notes.

purge

Delete all records of the image from the index.

Usage: !images purge target [index]

Arguments:

target

Page name or image url indicating which image to target.

index

For pages with multiple images, index specifies which image to use.

remove

Remove an image from the page.

Edits the page to remove the image code from the page source. If the image is uploaded to the page, the image file itself will not and should not be deleted.

Additionally, jarvis will automatically announce image removal via a discussion post, and send wikidot PMs to all authors of the page.

When using this command, please visually confirm afterwards that no elements of the page except the image were removed, and that the formatting of the page is unaffected by the removal.

Usage: !images remove page images

Arguments:

page

Name of the page.

images

Full urls of all the images that must be removed.

scan

Scan wiki pages.

Finds all images in the specified pages and adds them to the index.

Usage: !images scan pages

Arguments:

pages

Names of pages to be scanned for unindexed images.

search

Return reverse-image-seach links for the image.

Usage: !images search target [index]

Arguments:

target

Page name or image url indicating which image to target.

index

For pages with multiple images, index specifies which image to use.

stats

Show review statistics for an image category.

Usage: !images stats category

Arguments:

category

Name of the category for which to display the stats.

sync

Reload image index.

Useful when the index page had to be manually edited for any reason.

Usage: !images sync

tagcc

Tag eligible pages with the '_cc' tag.

Only pages for which *all* present images are licensed in a manner compatible with the site's license will be tagged. That means that all the images on the page must be either licensed under the Public Domain or the BY-SA CC license.

Usage: !images tagcc

update

Update image records.

Usage: !images update target [index] [--url url] [--page page] [--source source] [--status status] [--notes notes]

Arguments:

target

Page name or image url indicating which image to target.

index

For pages with multiple images, index specifies which image to use.

--url, -u

Update the url of the image. Useful when the image was rehosted or reuploaded.

--page, -p

Update the page on which the image resides.

--source, --origin, -o

Update the origin of the image. Should be a full valid url.

--status, -s

Update the image status.

--notes, -n

Add a note. Only addes one note, and only if no notes are present already. If more notes needs to be added, use .im notes instead.

kaktuskast

Access djkakt.us podcasts.

If episode index is provided, returns the detailed description of the episode. Otherwise, shows titles and links to the latest 3 episodes.

Usage: !kaktuskast [podcast] [index]

Arguments:

podcast

Partial name of the podcast to look for. Defaults to Kaktuskast.

index

Index of the episode to look up.

lastcreated

Display most recently created pages.

masstell

Send a single message to several users.

Usage: !masstell [names] [separator] [text] [--users users] [--message message]

Arguments:

names

IRC usernames of the users to whom the message is intended. Space-separated. Commas are automatically stripped off.

separator

The '|' character, used to separate the list of names from the text of the tell.

text

Text of the tell, to be sent to all the specified users.

--users, --cc

IRC usernames of the users to whom the message is intended. Space-separated. Commas are automatically stripped off. This is the depricated version of the argument. You should use the 'names' positional argument instead.

--message, --text

Text of the message. This is the depricated version of the argument. You should use the 'text' positional argument instead.

memo

Manage memos.

This command is disabled in #site19

Memos are short persistent messages storing useful information about the user. Memos are channel-specific and support cross-channel access. Each user can have only a single memo stored in a particular channel.

Unlike quotes, memo creation times are not preserved.

Usage: !memo [channel] [{add,append,del,count}]

Arguments:

channel

Switch to another channel.

mode

Name of the subcommand to execute.

-default-

Retrieve the specified user's memo.

Usage: !memo user

Arguments:

user

Name of the user whose memo is being retrieved.

add

Add a new memo.

If the specified user already has a memo in this channel, the operation will be aborted to prevent accidental overwrites.

If you wish to overwrite an old memo, delete it explicitly and add the new memo in its place afterwards.

Usage: !memo add user message

Arguments:

user

Name of the user whose memo is being added.

message

Text of the memo.

append

Append memo.

Adds additional text to the end of the previously stored memo, without deletiing the original.

Usage: !memo append user message

Arguments:

user

Name of the user whose memo is being appended.

message

Text to be appended to the memo.

count

Output the number of memos stored in this channel.

Usage: !memo count

del

Delete memo.

Deletion requires the full text of the memo in order to prevent accidental deletions, as well as to provide an additional copy of the deleted memo for the logs.

Usage: !memo del user

Arguments:

user

Name of the user whose memeo is being deleted.

mylevel

Show the user's permission level in the current channel.

name

Proceduraly generate a name for something.

Usage: !name [{}]

Arguments:

mode

Name of the subcommand to execute.

-default-

Generate a person's name.

By default generates full names of both genders.

Usage: !name [--male|--female] [--first|--last] [--prefix] [--suffix]

Arguments:

--male, -m

Generate male name.

--female, -f

Generate female name.

--first, --given, -g

Only generate the first name.

--last, -l

Only generate the family name.

--prefix, -p

Add a prefix to the name.

--suffix, -s

Add a suffix to the name.

onpage

Find the member list page on which the given user appears.

Iterates over the member lists until it find the required user. Be default, starts with the newest members and continues back in time.

Usage: !onpage user [--oldest_first]

Arguments:

user

Wikidot username of the user in question.

--oldest-first, -o

Start the search with oldest users.

outbound

Access outbound tells.

Outband tells are tells sent by the input user, which haven't been delivered to their targets yet.

Ignores messages sent to tell topics.

Usage: !outbound [--purge [purge]|--echo]

Arguments:

--purge, -p

Purge outbound tells. If a username is specified, the command will delete the tells sent to that user. Otherwise, all outbound tells will be deleted.

--echo, -e

Print all outbound tells. Full text and send time of each tell will be displayed.

quote

Manage quotes.

This command is disabled in #site19.

Usage: !quote [channel] [{add,del}]

Arguments:

channel

Switch to another channel.

mode

Name of the subcommand to execute.

-default-

Retrieve a quote.

Usage: !quote [user] [index]

Arguments:

user

Find a quote by the given user.

index

Get the quote at the given index.

add

Add new quote.

Usage: !quote add [date] user message

Arguments:

date

Override the quote creation time with the given date in the YYYY-MM-DD format.

user

Name of the user being quoted.

message

Text of the quote.

del

Delete quote.

Deletion requires the full text of the quote in order to prevent accidental deletions, as well as to provide an additional copy of the deleted memo for the logs.

Usage: !quote del user index

Arguments:

user

Name of the user whose quote is being deleted.

index

Index of the quote to be deleted.

random

Get a random page.

Usage: !random [title] [--exclude exclude] [--strict strict] [--tags tags] [--author author] [--rating rating] [--created created] [--fullname fullname]

Arguments:

title

Search for pages whose title contains the given words.

--exclude, -e

Exclude pages whose title contains the given words.

--strict, -s

An analogue of the [title] argument with strict word matching. Unlike the former, specifying '--strict part' will *not* return matches whose title contains 'particle'.

--tags, -t

Limit results to pages with specified tags. Follows the normal +/- wikidot tag notation.

--author, -a

Limit results to pages written by the specified user. Rewrites are supported. Unlike .au, this argument does not attempt to divine the name of the user based on a partial input. Full exact case-insensitive wikidot username must be provided.

--rating, -r

Limit results to pages with the specified rating. Supports exact ratings (20, =20); ratings above or below a given value (>100, <-10); or a range of ratings (20..50).

--created, -c

Limit results to pages created on the given date. Dates must follow the YYYY-MM-DD format. Partial dates are supported: specifying -c 2014-01 will return only pages created in January of 2014. Dates before or after (>2012 or <2015-10-05); as well as date ranges (2013-02-10..2013-02-20) are likewise supported.

--fullname, -f

Find a page by exact full name.

rejoin

Enter the specified channel.

Staff-only command.

reloadtitles

Update title cache.

rem

Shorthand for '!memo add'.

Usage: !rem user message

Arguments:

user

Name of the user whose memo is being added.

message

Text of the memo.

say

None

Usage: !say channel text

Arguments:

channel

None

text

None

search

Find scp-wiki pages.

Usage: !search [title] [--exclude exclude] [--strict strict] [--tags tags] [--author author] [--rating rating] [--created created] [--fullname fullname] [--summary]

Arguments:

title

Search for pages whose title contains the given words.

--exclude, -e

Exclude pages whose title contains the given words.

--strict, -s

An analogue of the [title] argument with strict word matching. Unlike the former, specifying '--strict part' will *not* return matches whose title contains 'particle'.

--tags, -t

Limit results to pages with specified tags. Follows the normal +/- wikidot tag notation.

--author, -a

Limit results to pages written by the specified user. Rewrites are supported. Unlike .au, this argument does not attempt to divine the name of the user based on a partial input. Full exact case-insensitive wikidot username must be provided.

--rating, -r

Limit results to pages with the specified rating. Supports exact ratings (20, =20); ratings above or below a given value (>100, <-10); or a range of ratings (20..50).

--created, -c

Limit results to pages created on the given date. Dates must follow the YYYY-MM-DD format. Partial dates are supported: specifying -c 2014-01 will return only pages created in January of 2014. Dates before or after (>2012 or <2015-10-05); as well as date ranges (2013-02-10..2013-02-20) are likewise supported.

--fullname, -f

Find a page by exact full name.

--summary, -u

Instead of showing the results of the search, output summary information about the found pages.

seen

Show the first message said by the user.

Usage: !seen [--first|--total] [--date] [channel] user

Arguments:

--first, -f

Display the first recorded message said by the user.

--total, -t

Display the total number of messages said by the user.

--date, -d

Display exact date.

channel

Switch to another channel.

user

Username to look for.

showmore

Show additional results from the last used command.

Usage: !showmore [index]

Arguments:

index

Index of the stored result you wish to see, starting with 1.

showtells

Check for incoming messages.

staff

Display a blurb for the given staff member.

steam

Find steam games by their title.

Usage: !steam title

Arguments:

title

Title of the game to search for.

tags

Find pages with the given tags.

tale

Find scp-wiki tales.

Usage: !tale [title] [--exclude exclude] [--strict strict] [--tags tags] [--author author] [--rating rating] [--created created] [--fullname fullname] [--summary]

Arguments:

title

Search for pages whose title contains the given words.

--exclude, -e

Exclude pages whose title contains the given words.

--strict, -s

An analogue of the [title] argument with strict word matching. Unlike the former, specifying '--strict part' will *not* return matches whose title contains 'particle'.

--tags, -t

Limit results to pages with specified tags. Follows the normal +/- wikidot tag notation.

--author, -a

Limit results to pages written by the specified user. Rewrites are supported. Unlike .au, this argument does not attempt to divine the name of the user based on a partial input. Full exact case-insensitive wikidot username must be provided.

--rating, -r

Limit results to pages with the specified rating. Supports exact ratings (20, =20); ratings above or below a given value (>100, <-10); or a range of ratings (20..50).

--created, -c

Limit results to pages created on the given date. Dates must follow the YYYY-MM-DD format. Partial dates are supported: specifying -c 2014-01 will return only pages created in January of 2014. Dates before or after (>2012 or <2015-10-05); as well as date ranges (2013-02-10..2013-02-20) are likewise supported.

--fullname, -f

Find a page by exact full name.

--summary, -u

Instead of showing the results of the search, output summary information about the found pages.

tell

Send messages to other users.

Saves the message and delivers them to the target next time they're in the same channel with the bot.

Usage: !tell user message

Arguments:

user

IRC username of the user to whom the message is intended.

message

Text of the message.

translate

Powered by Yandex.Translate (http://translate.yandex.com/).

Usage: !translate lang query

Arguments:

lang

Langauge codes for source and target language. For example, specifying ru-fr will translate your text from Russian into French. The source language can be optionally omitted.

query

Text you wish to translate.

tvtropes

Show laconic description of the trope, and a link to the full page.

Usage: !tvtropes query

Arguments:

query

Terms for which you wish to search.

unused

Get the first unused scp slot.

Usage: !unused [--random|--last|--count] [--prime] [--palindrome] [--divisible divisible] [--series series]

Arguments:

--random, -r

Return a random slot.

--last, -l

Return the last slot.

--count, -c

Return the number of matching slots.

--prime, -p

Limit matches to prime-numbered slots.

--palindrome, -i

Limit matches to slots whose number is a palindrome.

--divisible, -d

Limit matches to slots divisible by a given number. For example, '.unused -d 100' will return slots that end wtih 00.

--series, -s

Only check slots within the given series.

updatebans

Update the ban list.

updatehelp

Update the help page.

Staff-only command.

urbandictionary

Show urban defitiontion of a word or a phrase.

Usage: !urbandictionary query

Arguments:

query

Terms for which you wish to search.

user

Get wikidot profile url for the user.

version

Output version info.

Shows bot's bio, version number, github link, and uptime.

wandererslibrary

Find Wanderers' Library pages.

Usage: !wandererslibrary [title] [--exclude exclude] [--strict strict] [--tags tags] [--author author] [--rating rating] [--created created] [--fullname fullname] [--summary]

Arguments:

title

Search for pages whose title contains the given words.

--exclude, -e

Exclude pages whose title contains the given words.

--strict, -s

An analogue of the [title] argument with strict word matching. Unlike the former, specifying '--strict part' will *not* return matches whose title contains 'particle'.

--tags, -t

Limit results to pages with specified tags. Follows the normal +/- wikidot tag notation.

--author, -a

Limit results to pages written by the specified user. Rewrites are supported. Unlike .au, this argument does not attempt to divine the name of the user based on a partial input. Full exact case-insensitive wikidot username must be provided.

--rating, -r

Limit results to pages with the specified rating. Supports exact ratings (20, =20); ratings above or below a given value (>100, <-10); or a range of ratings (20..50).

--created, -c

Limit results to pages created on the given date. Dates must follow the YYYY-MM-DD format. Partial dates are supported: specifying -c 2014-01 will return only pages created in January of 2014. Dates before or after (>2012 or <2015-10-05); as well as date ranges (2013-02-10..2013-02-20) are likewise supported.

--fullname, -f

Find a page by exact full name.

--summary, -u

Instead of showing the results of the search, output summary information about the found pages.

wikipedia

Get wikipedia page about the topic.

Usage: !wikipedia query

Arguments:

query

Terms for which you wish to search.

youtube

Search youtube for stuff.

Usage: !youtube query [--index index]

Arguments:

query

Your search query.

--index, -i

Number of the result to show, between 1 and 10.

zyn

Marp.

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License