Kolmafia - User contributions [en]

Get path full

2014-11-26T22:53:24Z

Wrldwzrd89: This AGAIN?

{{
#vardefine:name|get_path_full}}{{
#vardefine:return_type|string}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=string|
return_also={{#var:return_also}}|
}}|

function_description=When called by a [[Relay Override Scripting|relay override script]], this returns the full URL that was submitted in the relay browser.|
code1={{CodeSample|
title=Code Sample|
description=Print path information about how the current override was called.|
code=<syntaxhighlight>
print( "This script was called by the URL: " + get_path_full() );
if( get_path_variables() != "" ) {
print( "Which is composed of the page name: " + get_path() );
print( "followed by a question mark and the variables: "+ get_path_variables() );
}
</syntaxhighlight>}}|

see_also={{SeeAlso|form_fields|get_path|get_path_variables}}|
special=When this function is called by any script that is not a relay override, it returns an empty string.|
}}

[[Category:Relay Browser Functions]]

Get path

2014-11-26T22:52:57Z

Wrldwzrd89: Sigh

{{
#vardefine:name|get_path}}{{
#vardefine:return_type|string}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=string|
return_also={{#var:return_also}}|
}}|

function_description=When called by a [[Relay Override Scripting|relay override script]], this returns the page name of the URL that was submitted in the relay browser. This does not include any variables which might follow a question mark in the URL.|
code1={{CodeSample|
title=Code Sample|
description=Print path information about how the current override was called.|
code=<syntaxhighlight>
print( "This script was called by the URL: " + get_path_full() );
if( get_path_variables() != "" ) {
print( "Which is composed of the page name: " + get_path() );
print( "followed by a question mark and the variables: "+ get_path_variables() );
}
</syntaxhighlight>}}|

see_also={{SeeAlso|form_fields|get_path_full|get_path_variables}}|
special=When this function is called by any script that is not a relay override, it returns an empty string.|
}}

[[Category:Relay Browser Functions]]

Get path variables

2014-11-26T22:52:20Z

Wrldwzrd89: Sentences should end with periods.

{{
#vardefine:name|get_path_variables}}{{
#vardefine:return_type|string}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=string|
return_also={{#var:return_also}}|
}}|

function_description=When called by a [[Relay Override Scripting|relay override script]], this returns the variables (if there are any after a "?") of the URL that was submitted in the relay browser. This return value does not include the name of the page.|
code1={{CodeSample|
title=Code Sample|
description=Print path information about how the current override was called.|
code=<syntaxhighlight>
print( "This script was called by the URL: " + get_path_full() );
if( get_path_variables() != "" ) {
print( "Which is composed of the page name: " + get_path() );
print( "followed by a question mark and the variables: "+ get_path_variables() );
}
</syntaxhighlight>}}|

see_also={{SeeAlso|form_fields|get_path_full|get_path}}|
special=When this function is called by any script that is not a relay override, it returns an empty string.|
}}

[[Category:Relay Browser Functions]]

Data Types

2014-11-26T22:45:17Z

Wrldwzrd89: /* element */ There are 7 values listed, but the description text says six possible values. Fix that.

{{TOCright}}
==Primitive Datatypes==

===void===
Can be thought of better as the absence of a datatype. No value can be assigned to '''void''' nor can a value be returned from a function of datatype '''void'''.

===boolean===
A boolean value is either '''true''' or '''false'''. By default, a boolean variable is set to false.

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 32-bit signed int, meaning it has a maximum value of 2,147,483,647 and a minimum value of -2,147,483,648. The default value of a integer variable is 0.

Be careful when doing math with integers! As with some other strongly-typed languages, numbers are converted to integers at every step of the operation when only integer types are used. For example:
{{
CodeSample|
code=
<syntaxhighlight>
int a = 1;
int b = 2;
print( a / b * 2 );
</syntaxhighlight>}}
Will give the output "0," not "1" as you may expect. Changing either variable to a float type will "correct" this.

===float===

The float data type is a single-precision 32-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in section 4.2.3 of the Java Language Specification. [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3]

When assigning to a variable of type float, one should be careful to always enter numbers in decimal form, as unwanted behavior can result from supplying a value that KoLmafia may interpret as an int type without the decimal point.

Note that float is not infinitely precise; it intrinsically rounds off after a certain point. This loss of accuracy is for the sake of storage, but beware of the possibility of small errors compounding from multiple float types.
{{
CodeSample|
description=For instance, try the following code as an example of how rather long post-decimal portions are handled:|
code=
<syntaxhighlight>
float f;
f = 4.9999999;
print( f );
</syntaxhighlight>}}
The default value of a <code>float</code> variable is 0.0.

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, always enclose the desired value in either single or double quotes (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.{{CodeSample|
description=For example:|
code=
<syntaxhighlight>
string s = "This is my \"friend\" Pete.";
</syntaxhighlight>|
moreinfo=
Will result in the following being stored to s:
<pre>This is my "friend" Pete</pre>}}
The default value of a string is an empty string, or literally <code>""</code>.

===buffer===

Similar to a string, but more efficient in certain operations, including concatenation and passing as function arguments. For the most part, you can interchange references to strings and buffers. However, you should test all such actions first, as a few functions require a specific datatype to be supplied as a parameter. (Most notably, those listed under [[String Handling Routines#Regular Expressions|Regular Expressions]].)

==Special Datatypes==

Several datatypes are included in KoLmafia to represent common categories within the KoL universe.

Note that while variables of these types are declared in the same way as for Primitive Datatypes; assigning and referencing them is done differently.
{{CodeSample|
description=For example, to declare an item datatype and assign it a value, you would use the following line of code:|
code=
<syntaxhighlight>
item it = $item[ broken skull ];
</syntaxhighlight>}}
The default values of any variable of one of the following types is <code>$''type''[ none ]</code>. For example, the default value of a <code>item</code> variable is <code>$item[ none ]</code>.

===bounty===

These are the non-items that the bounty hunter asks you to retrieve from monsters around the kingdom. There are quite a lot of them (42 in total) so I won't list them all here. You can find more about bounties at the {{kolwiki|The Bounty Hunter Hunter's Shack}}.

===class===

Besides $class[ none ], there are six possible values for this datatype:

* Seal Clubber
* Turtle Tamer
* Pastamancer
* Sauceror
* Disco Bandit
* Accordion Thief

===coinmaster===
All shops that deal with currency other than meat. Known values include:

* {{kolwiki|The Bounty Hunter Hunter's Shack|Bounty Hunter Hunter}}
* {{kolwiki|Mr. Store}}
* {{kolwiki|Hermit}}
* {{kolwiki|The Shore, Inc. Gift Shop}}
* {{kolwiki|The Trapper's Cabin|The Trapper}}
* {{kolwiki|A Vending Machine|Vending Machine}}
* {{kolwiki|The Swagger Shop}}
* {{kolwiki|The Hippy Camp (Wartime)|Dimemaster}}
* {{kolwiki|The Orcish Frat House|Quartersmaster}}
* {{kolwiki|BURT|Bugbear Token}}
* {{kolwiki|Freshwater Fishbonery}}
* {{kolwiki|Big Brother}}
* {{kolwiki|The Terrified Eagle Inn}}
* {{kolwiki|Ticket Redemption Counter|Arcade Ticket Counter}}
* {{kolwiki|Cashier|Game Shoppe}}
* {{kolwiki|Cashier|Game Shoppe Snacks}}
* {{kolwiki|The Isotope Smithery|Isotope Smithery}}
* {{kolwiki|Dollhawker's Emporium}}
* {{kolwiki|The Lunar Lunch-o-Mat|Lunar Lunch-o-Mat}}
* {{kolwiki|Paul's Boutique}}
* {{kolwiki|The Frozen Brogurt Stand}}
* {{kolwiki|Buff Jimmy's Souvenir Shop}}
* {{kolwiki|Taco Dan's Taco Stand}}
* {{kolwiki|You're the Fudge Wizard Now, Dog|Fudge Wand}}
* {{kolwiki|The Neandermall}}
* {{kolwiki|Legitimate Shoe Repair, Inc.}}
* {{kolwiki|warbear black box|Warbear Black Box}}

===effect===

Any effect you can be under in KoL, whether from items, skills, or what-have-you, is valid for this datatype.

The full range, besides $effect[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Effects}} page for more information.

===element===

Besides $element[ none ], there are seven possible values for this datatype. (Note that "Bad Spelling" is not considered a true element.)
Also note that these names are case-sensitive (referencing $element[ Spooky ] will generate an error).

* cold
* hot
* sleaze
* spooky
* stench
* slime
* supercold

===familiar===

Any familiar available in KoL is valid for this datatype.

The full range, besides $familiar[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Familiars}} page for more information.

===item===

Any item in all of KoL is valid for this datatype. Note that unlike most special datatypes, item references can make use of the item ID number.
{{CodeSample|
description=For example, you could assign the item plexiglass pants as follows:|
code=
<syntaxhighlight>
item it = $item[ 1234 ];
</syntaxhighlight>}}
The full range, besides $item[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Items}} page for more information.

===location===

Any location one can adventure at in KoL is valid for this datatype.

The full range, besides $location[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Locations}} page for more information.

===monster===

Any monster you can encounter in KoL is valid for this datatype.

The full range, besides $monster[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Monster Compendium}} page for more information.

===phylum===

Each monster has a {{kolwiki|Phylum}}. Besides $phylum[none], the possible values for this datatype are:

* beast
* bug
* constellation
* construct
* demon
* dude
* elemental
* elf
* fish
* goblin
* hippy
* hobo
* humanoid
* horror
* mer-kin
* orc
* penguin
* pirate
* plant
* slime
* undead
* weird

===skill===
Any skill you can have in KoL (whether permable or not, granted by items, etc.) is valid for this datatype.

The full range, besides $skill[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Skills}} page for more information.

===slot===

Besides $slot[ none ], there are 14 possible values for this datatype.

* hat
* back
* weapon
* off-hand
* shirt
* pants
* acc1
* acc2
* acc3
* familiar
* sticker1
* sticker2
* sticker3
* fakehand

===stat===

Besides $stat[ none ], there are six possible values for this datatype (the last three are for referencing sub-stats).

* muscle
* mysticality
* moxie
* submuscle
* submysticality
* submoxie

===thrall===

Pastamancers have the ability to summon {{kolwiki|Pasta Thralls}}.

* Angel Hair Wisp
* Elbow Macaroni
* Lasagmbie
* Penne Dreadful
* Spaghetti Elemental
* Spice Ghost
* Vampieroghi
* Vermincelli

==aggregate==

An aggregate is a complex datatype composed of two or more primitive or special datatypes. For more information, see [[Data Structures]].

==record==

Records are user-defined datatypes that hold as many sub-datatypes as desired. For more information, see the page for [[Data Structures]].

==Plural Typed Constants==

(see http://kolmafia.us/showthread.php?p=15592, from which this section is reproduced)

Plural typed constants allow you to easily do something with a list of specified objects, without having to replicate code or laboriously build up an array of the objects so that you can iterate over it. Here's a quick example:
{{CodeSample|code=<syntaxhighlight>
foreach weapon in $items[star sword, star staff, star crossbow] {
if (available_amount(weapon) > 0) {
equip(weapon);
break;
}
}</syntaxhighlight>}}
The syntax is basically the same as the existing typed constant feature, but with an "s" or "es" after the type name. (The "es" case is there so that you can properly pluralize "class".) The text between the square brackets is interpreted as a comma-separated list of elements, each of which is converted to the specified type as if it were an individual constant. More details:
* The list can span multiple lines.
* Whitespace before or after elements is ignored.
* Completely empty elements are ignored (so that you can leave a comma at the end of the list).
* You can include a comma or closing square bracket in an element by writing it as "\," or "\]".
* All the other escape sequences allowed in strings are possible, such as "\n" (newline), "\t" (tab), and "\uXXXX" (Unicode character value). To put an actual backslash in an element, you have to write it as "\\".

The value generated by a plural constant is of type boolean[type], with the keys being the specified elements, and the boolean value always being true - although you won't normally do anything with the boolean, you'd use a foreach loop to iterate over the keys. You can assign a plural constant to a variable declared as that type, but note that the value differs from a normal map in three important respects:
* Since the expression that generates it is syntactically a constant, the value has to be immutable. If you were allowed to change it in any way, those changes would appear in every future use of the same constant.
* There can be multiple instances of the same key - $ints[1,1,2,3,5,8] is perfectly valid, and will result in the value 1 appearing twice in a foreach loop.
* The keys will appear in the order you wrote them, rather than being sorted alphanumerically as maps usually do.

In addition to being used in a foreach loop, plural constants also efficiently support membership testing via the 'contains' operator. Here's another example:
{{CodeSample|code=<syntaxhighlight>
for hour from 1 to 12 {
print("It's " + hour + " o'clock.");
if ($ints[10, 2, 4] contains hour) {
print("Time to drink a Dr Pepper!");
}
}</syntaxhighlight>}}
(Yes, that example could just as easily have been done with a switch statement.)

Iterating over an empty list is rather pointless, so plural constants with no elements are given a different meaning: they represent every value of the specified type, where this is practical. (The 'none' value, if defined for a given type, is omitted.) The biggest benefit here is $items[], which lets you loop over every defined item, more efficiently than you could otherwise write in a script (since the list is generated once per session and then cached), and without having to hard-code a maximum item ID number in your script. Example:
{{CodeSample|code=<syntaxhighlight>
foreach it in $items[] {
if (autosell_price(it) == 42) print(it);
}</syntaxhighlight>}}
Enumeration of all possible values works with the following types:
* $booleans[] - false and true.
* $items[]
* $locations[]
* $classes[]
* $stats[] - Muscle, Mysticality, Moxie: the substat values are omitted.
* $skills[]
* $effects[]
* $familiars[]
* $slots[] - includes sticker slots and fake hands, which you might not want to consider as normal slots.
* $monsters[]
* $elements[] - includes slime now, and possibly other not-quite-elements like cute in the future.

The remaining types that can be used in plural constants require an explicit list of elements, since there are too many possible values:
* $ints[] - you don't have enough RAM to store a list with 4 billion elements.
* $floats[] - ditto.
* $strings[] - nobody has that much RAM.

==Custom==

===matcher===

A matcher isn't really a datatype so much as it's a class, but it is included here for reference, as it is used much as datatypes are in ASH. It can only be declared through the function {{f|create_matcher}}, using two strings. One is the string to find matches in, the other a regular expression to test against. For more information on using a matcher, see [[Regular Expressions]].

[[Category:Scripting]]

CLI Reference

2014-11-26T22:41:12Z

Wrldwzrd89: /* Developer */ Add some descriptions.

The KoLmafia Graphical CLI is one of the most helpful features Mafia has. This page is intended to provide information on the commands available.

=How to use these commands=

Square brackets [ ] enclose optional elements of commands. In command descriptions, they may also enclose the effects of using those optional elements.

Vertical bars | separate alternative elements - choose any one. (But note that || is an actual part of a few commands.)

An ellipsis ... after an element means that it can be repeated as many times as needed.

Elements in italics are placeholders - replace them with an actual name you want the command to operate on.

Commands with an asterisk * after the name are abbreviations - you can type them in a longer form if desired.

Some command names can be followed by a question mark (shown as [?] ), in which case the command will just display what it would do, rather than actually doing it.

When adventuring, or using an item or skill, the name can be preceded by a number specifying how many times to do it. An asterisk in place of this number means "as many as possible" or "the current quantity in inventory", depending on context. Negative numbers mean to do that many less than the maximum.

Usually, multiple commands can be given on the same line, separated by semicolons. The exceptions (alias, ash, ashq, cheapest, expensive, fecho, fprint, get, set, speculate, whatif, later) treat the entire remainder of the line as a parameter.

A few commands (elseif, else, if, try, while) treat at least one following command as a block that is executed conditionally or repetitively. The block consists of the remainder of the line, or the entire next line if that's empty. The block is extended by additional lines if it would otherwise end with one of these special commands.

===Quantity Parameter===
Any place that a number can be used to define a quantity, such as <code>autosell 5 heavy D</code>, you can use one of the following to indicate a variable quantity:
* <nowiki>*</nowiki> is used to indicate all items in inventory.
: <code>autosell * heavy D</code>
* 0 is also used to indicate all items in inventory.
: <code>autosell 0 heavy D</code>
* a negative number means sell off all items except for the number listed. For example, -5 means keep 5 and sell the rest.
: <code>autosell -5 heavy D</code>

===Item Parameter===
There are two ways to provide an item. By name or number.
* An item's name can be used in the obvious way, however this may sometimes fail because some items have numbers as part of their names. KoL's fuzzy matching will sometimes make a mistake such as interpreting {{Pspan|1 WA}} as a {{Pspan|100-watt light bulb}}.

* An item's ID number can be used to avoid any possibility of ambiguity. This also allows names with commas to be passed as parameters to functions that contain comma separated lists. To do this the item needs to be prefaced by a [http://en.wikipedia.org/wiki/Pilcrow pilcrow]. The character: ¶, is also known as a paragraph mark. It can be typed from your keyboard with a bit of know-how or included in an ash script as "\u00B6".
: <code>send 1 ¶4358 to Bale|Thanks for being awesome</code>
: is a way to send {{Pspan|A Crimbo Carol, Ch. 5}} to Bale despite the comma in the item's name.

=Commands=
==Equipment, Inventory and Consumption Management==
{| class="wikitable" border="1"
|-
! Command
! Arguments
! Description
|-
| *brewery*[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| *kitchen*[?]
| item
| consumes item at Hell's Kitchen, if available.
|-
| acquire
| item
| ensure that you have item, creating or buying it if needed.
|-
| accordions
|
| show information about accordions.
|-
| bake
| [ item... ]
| list creatables, or create specified items.
|-
| bjornify
| [familiar]
| list available familiars, or put a familiar in your {{kolwiki|Buddy Bjorn}}
|-
| chew[?]
| [either] item [, item]...
| use/consume items
|-
| cleanup
|
| use, pulverize, or autosell your junk items.
|-
| closet
| list ''filter'' | empty | put ''item''... | take ''item''...
| list or manipulate your closet.
|-
| create
| [ item... ]
| list creatables, or create specified items.
|-
| display
| [filter] | put item... | take item...
| list or manipulate your display case.
|-
| eat[?]
| [either] item [, item]...
| use/consume items
|-
| equip
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| find
| item
| ensure that you have item, creating or buying it if needed.
|-
| fold[?]
| item
| produce item by using another form, repeated as needed.
|-
| ghost[?]
| [either] item [, item]...
| use/consume items
|-
| hagnk
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| hermit[?]
| [item]
| get clover status, or trade for item.
|-
| hobo[?]
| [either] item [, item]...
| use/consume items
|-
| inv*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| junk
|
| use, pulverize, or autosell your junk items.
|-
| make
| [ item... ]
| list creatables, or create specified items.
|-
| maximize[?]
| [+|-|weight] keyword, ...
| run the [[Modifier Maximizer]].
|-
| mix
| [ item... ]
| list creatables, or create specified items.
|-
| modifies
| filter
| list all possible sources of modifiers matching filter.
|-
| [[Modifiers|modref]]
| [object]
| list all modifiers, show values for player [and object].
|-
| modtrace
| filter
| list everything that adds to modifiers matching filter.
|-
| outfit
| [list filter] | save name | checkpoint | name
| list, save, restore, or change outfits.
|-
| overdrink[?]
| [either] item [, item]...
| use/consume items
|-
| ply
| [ item... ]
| list creatables, or create specified items.
|-
| pull
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| pulverize
| item [, item]...
| pulverize specified items
|-
| quark[?]
| [itemList...]
| gain MP by pasting unstable quark with best item from itemList (or your junk list).
|-
| remove
| slot | name
| remove equipment in slot, or that matches name
|-
| restaurant[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| retrieve
| item
| ensure that you have item, creating or buying it if needed.
|-
| skeeball
| [count]
| squander Game Grid tokens at the broken Skeeball machine
|-
| slime-stack*
|
| show details of slime stacks disgorged by Slimeling
|-
| slimeling[?]
| [either] item [, item]...
| use/consume items
|-
| smash
| item [, item]...
| pulverize specified items
|-
| smith
| [ item... ]
| list creatables, or create specified items.
|-
| [[speculate]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| squeeze[?]
| item
| produce item by using another form, repeated as needed.
|-
| stash
| [put] item... | take item...
| exchange items with clan stash
|-
| sticker*
| sticker1 [, sticker2 [, sticker3]]
| replace worn stickers.
|-
| storage
| [param]
| list indicated type of data, possibly filtered by param.
|-
| tinker
| [ item... ]
| list creatables, or create specified items.
|-
| wear
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| [[whatif]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| wield
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| zap
| item [, item]...
| transform items with your wand.
|}

==Quests==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| !
|
| list the Dungeons of Doom potions you've identified.
|-
| bang
|
| list the Dungeons of Doom potions you've identified.
|-
| baron
|
| finds the baron in the Tavern.
|-
| bugbears
|
| List progress of {{kolwiki|Bugbear Invasion|bugbear hunting}}.
|-
| chamber
|
| automatically complete quest.
|-
| council
|
| visit the Council to advance quest progress.
|-
| dusty
|
| list the dusty bottles of wine you've identified.
|-
| entryway
| [clover]
| automatically complete quest [using a clover].
|-
| factory
| report digits
| Given a string of 7 dwarven digits, report on factory.
|-
| gourd
|
| automatically complete quest.
|-
| grandpa
| query
| Ask Grandpa about something.
|-
| guardians
|
| automatically complete quest.
|-
| guild
|
| automatically complete quest.
|-
| hedge*
|
| automatically complete quest.
|-
| insults
|
| list the pirate insult comebacks you know.
|-
| leaflet
| [nomagic] | location | command
| complete leaflet quest [without using magic words].
|-
| maze
|
| automatically complete quest.
|-
| nemesis
|
| automatically complete quest.
|-
| poolskill
|
| calculates your current pool skill
|-
| spookyraven
| [on | off]
| when enabled, tracks Lights Out all the time
|-
| tavern
|
| automatically complete quest.
|-
| telescope
| [look] high | low
| get daily buff, or Lair hints from your telescope.
|-
| tower
|
| automatically complete quest.
|}

==Capitalism==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| automall
|
| dump all profitable, non-memento items into the Mall.
|-
| autosell
| item [, item]...
| autosell items.
|-
| buy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| cheapest[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| expensive[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| mallbuy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| mallsell
| item [[@] price [[limit] num]] [, another]...
| sell in Mall.
|-
| reprice
|
| price all max-priced items at or below current Mall minimum price.
|-
| searchmall
| item [ with limit number ]
| search the Mall.
|-
| sell
| item [, item]...
| autosell items.
|-
| shop
| put item [[@] price [[limit] num]] [, another] | take [all] item [, another]
| put item into the mall or take from from mall.
|-
| undercut
|
| price all max-priced items at or below current Mall minimum price.
|-
| untinker
| [ item... ]
| complete quest, or untinker items.
|-
| use[?]
| [either] item [, item]...
| use/consume items
|}

==Mafia==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| adv*[?]
| last | [count] location
| spend your turns.
|-
| abort
| [message]
| stop current script or automated task.
|-
| [[alias]]
| [ word => expansion ]
| list or create CLI abbreviations.
|-
| [[ash (CLI)|ash]]
| statement
| test a line of ASH code without having to edit a script.
|-
| [[ash (CLI)|ashq]]
| statement
| Like ash, but does not display the return value.
|-
| [[ashwiki]]
| searchText
| perform search on KoLmafia Wiki.
|-
| ashref
| [filter]
| summarize ASH built-in functions [matching filter].
|-
| backtrace
| text | off
| dump stack when a gCLI message or page URL matches text (case-sensitive).
|-
| breakfast
|
| perform start-of-day activities.
|-
| budget
| [number]
| show [or set] the number of budgeted Hagnk's pulls.
|-
| buffbot
| number
| run buffbot for number iterations.
|-
| cache
| [clear]
| get image cache status or clear cache.
|-
| call
| [numberx] filename | function [parameters]
| check/run script.
|-
| ccs
| [script]
| show [or select] Custom Combat Script in use.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| chat
|
| switch to tab or open window
|-
| check
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| checkpoint
|
| remembers current equipment, use "outfit checkpoint" to restore.
|-
| [[choice (CLI)|choice]]
| [number|text]
| list or choose choice adventure options.
|-
| [[choice (CLI)|choice-goal]]
|
| automatically complete quest.
|-
| clear
|
| clear CLI window.
|-
| cls
|
| clear CLI window.
|-
| [[condition]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| condref
|
| list conditions usable with if/while commands.
|-
| [[counters]]
| [ clear | add number [title img] ]
| show, clear, or add to current turn counters.
|-
| debug
| [on] | off
| start or stop logging of debugging data.
|-
| disable
| all | command [, command]...
| allow/deny CLI commands.
|-
| events
| [clear]
| clear or show recent events.
|-
| exec*
| [numberx] filename | function [parameters]
| check/run script.
|-
| exit
|
| logout and exit KoLmafia.
|-
| gc
|
| force Java garbage collection.
|-
| garden
| [pick]
| get status of garden, or harvest it.
|-
| gear
|
| switch to tab or open window
|-
| get
| preference [ = value ]
| show/change preference settings
|-
| [[goal]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| graygui
| [force]
| print out a stack trace to help figure out why the UI might be gray/stuck (requires use of the JDK instead of the JRE).
|-
| greygui
|
| same as graygui
|-
| hatter
| [hat]
| List effects you can get by wearing available hats at the hatter's tea party. If parameter is provided, get the buff for that hat. (Using a potion if necessary.)
|-
| help
| [filter]
| list CLI commands [that match filter].
|-
| item
|
| switch to tab or open window
|-
| [jukebox]
| song
| listen to a song on your clan's jukebox.
|-
| later
| commands
| adds a button to do commands to the Daily Deeds list.
|-
| load
| [numberx] filename | function [parameters]
| check/run script.
|-
| location
| snarfblat loc
| Adds a new location named loc with the snarfblat number specified. This does not persist across session.
|-
| log
| [status],[equipment],[effects],[etc.]
| record data, "log snapshot" for all common data.
|-
| logecho
| timestamp | text
| include timestamp or text in the session log only.
|-
| login
| username
| logout then log back in as username.
|-
| logout
|
| logout and return to login window.
|-
| logprint
| timestamp | text
| include timestamp or text in the session log only.
|-
| mail
|
| switch to tab or open window
|-
| mood*
| list | listall | clear | autofill | execute | repeat [numTimes] | moodName [numTimes]
| mood management.
|-
| neweffect
| effect description ID
| learn a new effect (add to database override)
|-
| [[objective]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| opt*
|
| switch to tab or open window
|-
| print
| timestamp | text
| include timestamp or text in the session log.
|-
| priphea
|
| launch KoLmafia GUI.
|-
| quit
|
| logout and exit KoLmafia.
|-
| radio
|
| switch to tab or open window
|-
| relay
|
| open the relay browser.
|-
| refresh
| all | status | equip | inv | storage | familiar | stickers
| resynchronize with KoL.
|-
| repeat
| [number]
| repeat previous line [number times].
|-
| restores
| [all | obtainable]
| List details of restores. (current, all or obtainable)
|-
| run
| [numberx] filename | function [parameters]
| check/run script.
|-
| save
| as mood
| add your current effects to the mood.
|-
| session
| [param]
| list indicated type of data, possibly filtered by param.
|-
| set
| preference [ = value ]
| show/change preference settings
|-
| start
| [numberx] filename | function [parameters]
| check/run script.
|-
| [[Svn#CLI_Commands|svn]]
| heckout ''svnurl'' | update [''svnurl''] | list | delete ''project'' | sync
| install/update/manage svn ''projects''.
|-
| [[trigger]]*
| clear | autofill | [type,] effect [, action]
| edit current mood. Options for type are gain_effect, lose_effect, unconditional
|-
| unalias
| word
| remove a CLI abbreviation.
|-
| update
| data | clear | prices URL or filename
| download most recent data files, or revert to built-in data.
|-
| validate
| [numberx] filename | function [parameters]
| check/run script.
|-
| verify
| [numberx] filename | function [parameters]
| check/run script.
|-
| version
|
| display KoLmafia version.
|}

==Scripting==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| <inline-ash-script>
|
| embed an ASH script in a CLI script.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| colorecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| echo
| timestamp | text
| include timestamp or text in the session log.
|-
| else
| ; commands
| do commands if preceding if/while/try didn't execute.
|-
| elseif
| condition; commands
| do if condition is true but preceding condition was false.
|-
| if
| condition; commands
| do commands once if condition is true (see condref).
|-
| [[using|namespace]]
| [filter]
| list namespace scripts and the functions they define.
|-
| pause
| [seconds]
| pause script execution (default 1 second).
|-
| try
| ; commands
| do commands, and continue even if an error occurs.
|-
| [[using]]
| filename
| add ASH script to namespace.
|-
| wait
| [seconds]
| pause script execution (default 1 second).
|-
| while
| condition; commands
| do commands repeatedly while condition is true.
|}

==Other==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| *.php*
|
| visit URL without showing results.
|-
| *mirror*
| [filename]
| stop [or start] logging to an additional file.
|-
| aa
| skill
| set default attack method.
|-
| [[PvP Commands|attack]]
| attack target [, target...]
| PvP for items or fame
|-
| autoattack
| skill
| set default attack method.
|-
| ballpit
|
| jump in your clan's awesome ball pit.
|-
| basement
|
| check Fernswarthy's Basement status.
|-
|-
| banishes
|
| display information about current banishes.
|-
| bounty
| [ easy | hard | special]
| List or optionally accept bounties of given difficulty
|-
| [[enthrone (CLI)|bjornify]][?]
| species
| place a familiar in the Buddy Bjorn.
|-
| burn
| extra | * | num | -num
| use excess/all/specified/all but specified MP for buff extension and summons.
|-
| [[camp]]*
| rest | etc. [numTimes]
| perform campground actions.
|-
| cast[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| chips
| type [,type [,type]]
| buy chips from your clan's snack machine: radium, ennui, wintergreen
|-
| clan
| [ snapshot | stashlog ]
| clan management.
|-
| coinmaster
| (buy | sell) nickname item [,item] ...
| buy or sell items to specified coinmaster.
|-
| crimbotree
| [ get ]
| check [or get present from] the Crimbo Tree in your clan's VIP lounge
|-
| csend
| item [, item]... to recipient [ || message ]
| send kmail
|-
| dad
|
| show the round-by-round elemental weaknesses of Dad Sea Monkee.
|-
| demons
|
| list the demon names you know.
|-
| donate
| boris | mus | jarl | mys | pete | mox amount
| donate in Hall of Legends.
|-
| drink[?]
| [either] item [, item]...
| use/consume items
|-
| effects
| [param]
| list indicated type of data, possibly filtered by param.
|-
| enable
| all | command [, command]...
| allow/deny CLI commands.
|-
| encounters
| [param]
| list indicated type of data, possibly filtered by param.
|-
| entity
|
| give details of your current pastamancer combat entity.
|-
| [[enthrone (CLI)|enthrone]][?]
| species
| place a familiar in the Crown of Thrones.
|-
| eudora
| penpal | game lock | xi
| switch to the specified correspondent
|-
| familiar[?]
| [list filter] | lock | unlock | species | none
| list or change familiar types
|-
| fax
| send | put | receive | get
| use the fax machine in your clan's VIP lounge
|-
| faxbot
| [command]
| send the command cmd to faxbot
|-
| field
| [ plant square type | pick square | harvest ]
| view or use your mushroom plot
|-
| florist
| plant [plantname]
| Add the plant to your current location
|-
| [[holiday]]
| [[PvP Commands|flowers]]
|
| commit random acts of PvP.
|-
| forum*
|
| visit the official KoL forums.
|-
| friars
| [blessing] food | familiar | booze
| get daily blessing.
|-
| galaktik
| (hp | mp) [amount]
| restore amount or all hp or mp
|-
| grim
| init | hpmp | damage
| get a Grim Brother buff
|-
| HolidayName
| enable special processing for unpredicted holidays.
|-
| hottub
|
| soak in your clan's hot tub
|-
| http:*
|
| visit URL without showing results.
|-
| ingredients
| item [, item]...
| get ingredients or recipe for items
|-
| kmail
| item [, item]... to recipient [ || message ]
| send kmail
|-
| locations
| [param]
| list indicated type of data, possibly filtered by param.
|-
| lookup
| item | effect
| go to appropriate KoL Wiki page.
|-
| mcd
| number
| set mind control device (or equivalent) to new value.
|-
| mind-control
| number
| set mind control device (or equivalent) to new value.
|-
| moleref
|
| Path of the Mole spoilers.
|-
| monsters
| location
| show combat details for the specified area.
|-
| moon*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| mpitems
|
| counts MP restoratives in inventory.
|-
| nuns
| [mp]
| visit the Nunnery for restoration [but only if MP is restored].
|-
| olfact*
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[panda]]
| moan | temple | comedy type | arena bandmember item
| interact with NPCs in Pandamonium
|-
| pool
| type [,type [,type]]
| play pool games in your clan's VIP lounge
|-
| putty
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[PvP Commands|pvp]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| pvplog*
|
| summarize PvP results.
|-
| raffle
| ticketsToBuy [ inventory | storage ]
| buy raffle tickets
|-
| recipe
| item [, item]...
| get ingredients or recipe for items.
|-
| recover*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| remedy[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| restore*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| safe
| location
| show summary data for the specified area.
|-
| send
| item [, item]... to recipient [ || message ]
| send kmail
|-
| shower
| cold | ice | cool | moxie | lukewarm | mysticality | warm | muscle | hot | mp
| take a shower in your clan's VIP lounge
|-
| shrug[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| skeleton
| warrior | cleric | wizard | rogue | buddy
| Use a single skeleton and select from the choice adventure according to the parameter
|-
| skill[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| skills
| [param]
| list indicated type of data, possibly filtered by param.
|-
| sleep
| number
| rest on your clan sofa for number turns.
|-
| soak
|
| soak in your clan's VIP hot tub
|-
| sofa
| number
| rest on your clan sofa for number turns.
|-
| spade
| [prices URL]
| submit automatically gathered data.
|-
| status
| [param]
| list indicated type of data, possibly filtered by param.
|-
| [[PvP Commands|steal]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| styx
| muscle | mysticality | moxie
| get daily Styx Pixie buff.
|-
| summary
| [param]
| list indicated type of data, possibly filtered by param.
|-
| summon
| demonName | effect | location | number
| use the Summoning Chamber.
|-
| [[PvP Commands|swagger]]
|
| commit random acts of PvP.
|-
| swim
| laps | ml | sprints | noncombat
| work out in your clan's VIP lounge swimming pool
|-
| text
| URL
| show text results from visiting URL.
|-
| train
| base weight | buffed weight | turns number
| train familiar.
|-
| uneffect[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| unequip
| slot | name
| remove equipment in slot, or that matches name
|-
| up?
| effect [, effect]...
| extend duration of effects.
|-
| wiki
| searchText
| perform search on KoL Wiki.
|-
| win
| game
| I'm as surprised as you! I didn't think it was possible.
|}

==Developer==
None of these commands take arguments.
{| class="wikitable" border="1"
|-
! Command Name
! Added to KoLmafia
! Description
|-
| checkconsumption
| rXXXX
| description goes here
|-
| checkeffects
| r6966
| Check KoLmafia's effect data for correctness.
|-
| checkfamiliars
| rXXXX
| description goes here
|-
| checkitems
| r6966
| description goes here
|-
| checkmodifiers
| r4640
| Check KoLmafia's modifier data for correctness.
|-
| checkoutfits
| r14949
| description goes here
|-
| checkplurals
| rXXXX
| description goes here
|-
| checkpotions
| r9791
| description goes here
|-
| checkpowers
| r9080
| Check KoLmafia's equipment power data for correctness. Note: This is only done for equipment you possess.
|-
| checkprofile
| r6539
| description goes here
|-
| checkpulverization
| rXXXX
| description goes here
|-
| checkshields
| r9091
| Check KoLmafia's equipment data pertaining to shields for correctness.
|-
| checkzapgroups
| rXXXX
| description goes here
|}

[[Category:CLI Commands]]

User:Wrldwzrd89

2014-11-16T20:31:48Z

Wrldwzrd89: Creating my user page.

Hi, I'm Wrldwzrd89, a KoLmafia user and scripter. I'm here to fill in some of the KoLmafia wiki's gaps.

CLI Reference

2014-11-16T20:30:25Z

Wrldwzrd89: /* Developer */ Add revisions for most of the developer commands

The KoLmafia Graphical CLI is one of the most helpful features Mafia has. This page is intended to provide information on the commands available.

=How to use these commands=

Square brackets [ ] enclose optional elements of commands. In command descriptions, they may also enclose the effects of using those optional elements.

Vertical bars | separate alternative elements - choose any one. (But note that || is an actual part of a few commands.)

An ellipsis ... after an element means that it can be repeated as many times as needed.

Elements in italics are placeholders - replace them with an actual name you want the command to operate on.

Commands with an asterisk * after the name are abbreviations - you can type them in a longer form if desired.

Some command names can be followed by a question mark (shown as [?] ), in which case the command will just display what it would do, rather than actually doing it.

When adventuring, or using an item or skill, the name can be preceded by a number specifying how many times to do it. An asterisk in place of this number means "as many as possible" or "the current quantity in inventory", depending on context. Negative numbers mean to do that many less than the maximum.

Usually, multiple commands can be given on the same line, separated by semicolons. The exceptions (alias, ash, ashq, cheapest, expensive, fecho, fprint, get, set, speculate, whatif, later) treat the entire remainder of the line as a parameter.

A few commands (elseif, else, if, try, while) treat at least one following command as a block that is executed conditionally or repetitively. The block consists of the remainder of the line, or the entire next line if that's empty. The block is extended by additional lines if it would otherwise end with one of these special commands.

===Quantity Parameter===
Any place that a number can be used to define a quantity, such as <code>autosell 5 heavy D</code>, you can use one of the following to indicate a variable quantity:
* <nowiki>*</nowiki> is used to indicate all items in inventory.
: <code>autosell * heavy D</code>
* 0 is also used to indicate all items in inventory.
: <code>autosell 0 heavy D</code>
* a negative number means sell off all items except for the number listed. For example, -5 means keep 5 and sell the rest.
: <code>autosell -5 heavy D</code>

===Item Parameter===
There are two ways to provide an item. By name or number.
* An item's name can be used in the obvious way, however this may sometimes fail because some items have numbers as part of their names. KoL's fuzzy matching will sometimes make a mistake such as interpreting {{Pspan|1 WA}} as a {{Pspan|100-watt light bulb}}.

* An item's ID number can be used to avoid any possibility of ambiguity. This also allows names with commas to be passed as parameters to functions that contain comma separated lists. To do this the item needs to be prefaced by a [http://en.wikipedia.org/wiki/Pilcrow pilcrow]. The character: ¶, is also known as a paragraph mark. It can be typed from your keyboard with a bit of know-how or included in an ash script as "\u00B6".
: <code>send 1 ¶4358 to Bale|Thanks for being awesome</code>
: is a way to send {{Pspan|A Crimbo Carol, Ch. 5}} to Bale despite the comma in the item's name.

=Commands=
==Equipment, Inventory and Consumption Management==
{| class="wikitable" border="1"
|-
! Command
! Arguments
! Description
|-
| *brewery*[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| *kitchen*[?]
| item
| consumes item at Hell's Kitchen, if available.
|-
| acquire
| item
| ensure that you have item, creating or buying it if needed.
|-
| accordions
|
| show information about accordions.
|-
| bake
| [ item... ]
| list creatables, or create specified items.
|-
| bjornify
| [familiar]
| list available familiars, or put a familiar in your {{kolwiki|Buddy Bjorn}}
|-
| chew[?]
| [either] item [, item]...
| use/consume items
|-
| cleanup
|
| use, pulverize, or autosell your junk items.
|-
| closet
| list ''filter'' | empty | put ''item''... | take ''item''...
| list or manipulate your closet.
|-
| create
| [ item... ]
| list creatables, or create specified items.
|-
| display
| [filter] | put item... | take item...
| list or manipulate your display case.
|-
| eat[?]
| [either] item [, item]...
| use/consume items
|-
| equip
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| find
| item
| ensure that you have item, creating or buying it if needed.
|-
| fold[?]
| item
| produce item by using another form, repeated as needed.
|-
| ghost[?]
| [either] item [, item]...
| use/consume items
|-
| hagnk
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| hermit[?]
| [item]
| get clover status, or trade for item.
|-
| hobo[?]
| [either] item [, item]...
| use/consume items
|-
| inv*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| junk
|
| use, pulverize, or autosell your junk items.
|-
| make
| [ item... ]
| list creatables, or create specified items.
|-
| maximize[?]
| [+|-|weight] keyword, ...
| run the [[Modifier Maximizer]].
|-
| mix
| [ item... ]
| list creatables, or create specified items.
|-
| modifies
| filter
| list all possible sources of modifiers matching filter.
|-
| [[Modifiers|modref]]
| [object]
| list all modifiers, show values for player [and object].
|-
| modtrace
| filter
| list everything that adds to modifiers matching filter.
|-
| outfit
| [list filter] | save name | checkpoint | name
| list, save, restore, or change outfits.
|-
| overdrink[?]
| [either] item [, item]...
| use/consume items
|-
| ply
| [ item... ]
| list creatables, or create specified items.
|-
| pull
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| pulverize
| item [, item]...
| pulverize specified items
|-
| quark[?]
| [itemList...]
| gain MP by pasting unstable quark with best item from itemList (or your junk list).
|-
| remove
| slot | name
| remove equipment in slot, or that matches name
|-
| restaurant[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| retrieve
| item
| ensure that you have item, creating or buying it if needed.
|-
| skeeball
| [count]
| squander Game Grid tokens at the broken Skeeball machine
|-
| slime-stack*
|
| show details of slime stacks disgorged by Slimeling
|-
| slimeling[?]
| [either] item [, item]...
| use/consume items
|-
| smash
| item [, item]...
| pulverize specified items
|-
| smith
| [ item... ]
| list creatables, or create specified items.
|-
| [[speculate]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| squeeze[?]
| item
| produce item by using another form, repeated as needed.
|-
| stash
| [put] item... | take item...
| exchange items with clan stash
|-
| sticker*
| sticker1 [, sticker2 [, sticker3]]
| replace worn stickers.
|-
| storage
| [param]
| list indicated type of data, possibly filtered by param.
|-
| tinker
| [ item... ]
| list creatables, or create specified items.
|-
| wear
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| [[whatif]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| wield
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| zap
| item [, item]...
| transform items with your wand.
|}

==Quests==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| !
|
| list the Dungeons of Doom potions you've identified.
|-
| bang
|
| list the Dungeons of Doom potions you've identified.
|-
| baron
|
| finds the baron in the Tavern.
|-
| bugbears
|
| List progress of {{kolwiki|Bugbear Invasion|bugbear hunting}}.
|-
| chamber
|
| automatically complete quest.
|-
| council
|
| visit the Council to advance quest progress.
|-
| dusty
|
| list the dusty bottles of wine you've identified.
|-
| entryway
| [clover]
| automatically complete quest [using a clover].
|-
| factory
| report digits
| Given a string of 7 dwarven digits, report on factory.
|-
| gourd
|
| automatically complete quest.
|-
| grandpa
| query
| Ask Grandpa about something.
|-
| guardians
|
| automatically complete quest.
|-
| guild
|
| automatically complete quest.
|-
| hedge*
|
| automatically complete quest.
|-
| insults
|
| list the pirate insult comebacks you know.
|-
| leaflet
| [nomagic] | location | command
| complete leaflet quest [without using magic words].
|-
| maze
|
| automatically complete quest.
|-
| nemesis
|
| automatically complete quest.
|-
| poolskill
|
| calculates your current pool skill
|-
| spookyraven
| [on | off]
| when enabled, tracks Lights Out all the time
|-
| tavern
|
| automatically complete quest.
|-
| telescope
| [look] high | low
| get daily buff, or Lair hints from your telescope.
|-
| tower
|
| automatically complete quest.
|}

==Capitalism==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| automall
|
| dump all profitable, non-memento items into the Mall.
|-
| autosell
| item [, item]...
| autosell items.
|-
| buy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| cheapest[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| expensive[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| mallbuy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| mallsell
| item [[@] price [[limit] num]] [, another]...
| sell in Mall.
|-
| reprice
|
| price all max-priced items at or below current Mall minimum price.
|-
| searchmall
| item [ with limit number ]
| search the Mall.
|-
| sell
| item [, item]...
| autosell items.
|-
| shop
| put item [[@] price [[limit] num]] [, another] | take [all] item [, another]
| put item into the mall or take from from mall.
|-
| undercut
|
| price all max-priced items at or below current Mall minimum price.
|-
| untinker
| [ item... ]
| complete quest, or untinker items.
|-
| use[?]
| [either] item [, item]...
| use/consume items
|}

==Mafia==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| adv*[?]
| last | [count] location
| spend your turns.
|-
| abort
| [message]
| stop current script or automated task.
|-
| [[alias]]
| [ word => expansion ]
| list or create CLI abbreviations.
|-
| [[ash (CLI)|ash]]
| statement
| test a line of ASH code without having to edit a script.
|-
| [[ash (CLI)|ashq]]
| statement
| Like ash, but does not display the return value.
|-
| [[ashwiki]]
| searchText
| perform search on KoLmafia Wiki.
|-
| ashref
| [filter]
| summarize ASH built-in functions [matching filter].
|-
| backtrace
| text | off
| dump stack when a gCLI message or page URL matches text (case-sensitive).
|-
| breakfast
|
| perform start-of-day activities.
|-
| budget
| [number]
| show [or set] the number of budgeted Hagnk's pulls.
|-
| buffbot
| number
| run buffbot for number iterations.
|-
| cache
| [clear]
| get image cache status or clear cache.
|-
| call
| [numberx] filename | function [parameters]
| check/run script.
|-
| ccs
| [script]
| show [or select] Custom Combat Script in use.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| chat
|
| switch to tab or open window
|-
| check
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| checkpoint
|
| remembers current equipment, use "outfit checkpoint" to restore.
|-
| [[choice (CLI)|choice]]
| [number|text]
| list or choose choice adventure options.
|-
| [[choice (CLI)|choice-goal]]
|
| automatically complete quest.
|-
| clear
|
| clear CLI window.
|-
| cls
|
| clear CLI window.
|-
| [[condition]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| condref
|
| list conditions usable with if/while commands.
|-
| [[counters]]
| [ clear | add number [title img] ]
| show, clear, or add to current turn counters.
|-
| debug
| [on] | off
| start or stop logging of debugging data.
|-
| disable
| all | command [, command]...
| allow/deny CLI commands.
|-
| events
| [clear]
| clear or show recent events.
|-
| exec*
| [numberx] filename | function [parameters]
| check/run script.
|-
| exit
|
| logout and exit KoLmafia.
|-
| gc
|
| force Java garbage collection.
|-
| garden
| [pick]
| get status of garden, or harvest it.
|-
| gear
|
| switch to tab or open window
|-
| get
| preference [ = value ]
| show/change preference settings
|-
| [[goal]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| graygui
| [force]
| print out a stack trace to help figure out why the UI might be gray/stuck (requires use of the JDK instead of the JRE).
|-
| greygui
|
| same as graygui
|-
| hatter
| [hat]
| List effects you can get by wearing available hats at the hatter's tea party. If parameter is provided, get the buff for that hat. (Using a potion if necessary.)
|-
| help
| [filter]
| list CLI commands [that match filter].
|-
| item
|
| switch to tab or open window
|-
| [jukebox]
| song
| listen to a song on your clan's jukebox.
|-
| later
| commands
| adds a button to do commands to the Daily Deeds list.
|-
| load
| [numberx] filename | function [parameters]
| check/run script.
|-
| location
| snarfblat loc
| Adds a new location named loc with the snarfblat number specified. This does not persist across session.
|-
| log
| [status],[equipment],[effects],[etc.]
| record data, "log snapshot" for all common data.
|-
| logecho
| timestamp | text
| include timestamp or text in the session log only.
|-
| login
| username
| logout then log back in as username.
|-
| logout
|
| logout and return to login window.
|-
| logprint
| timestamp | text
| include timestamp or text in the session log only.
|-
| mail
|
| switch to tab or open window
|-
| mood*
| list | listall | clear | autofill | execute | repeat [numTimes] | moodName [numTimes]
| mood management.
|-
| neweffect
| effect description ID
| learn a new effect (add to database override)
|-
| [[objective]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| opt*
|
| switch to tab or open window
|-
| print
| timestamp | text
| include timestamp or text in the session log.
|-
| priphea
|
| launch KoLmafia GUI.
|-
| quit
|
| logout and exit KoLmafia.
|-
| radio
|
| switch to tab or open window
|-
| relay
|
| open the relay browser.
|-
| refresh
| all | status | equip | inv | storage | familiar | stickers
| resynchronize with KoL.
|-
| repeat
| [number]
| repeat previous line [number times].
|-
| restores
| [all | obtainable]
| List details of restores. (current, all or obtainable)
|-
| run
| [numberx] filename | function [parameters]
| check/run script.
|-
| save
| as mood
| add your current effects to the mood.
|-
| session
| [param]
| list indicated type of data, possibly filtered by param.
|-
| set
| preference [ = value ]
| show/change preference settings
|-
| start
| [numberx] filename | function [parameters]
| check/run script.
|-
| [[Svn#CLI_Commands|svn]]
| heckout ''svnurl'' | update [''svnurl''] | list | delete ''project'' | sync
| install/update/manage svn ''projects''.
|-
| [[trigger]]*
| clear | autofill | [type,] effect [, action]
| edit current mood. Options for type are gain_effect, lose_effect, unconditional
|-
| unalias
| word
| remove a CLI abbreviation.
|-
| update
| data | clear | prices URL or filename
| download most recent data files, or revert to built-in data.
|-
| validate
| [numberx] filename | function [parameters]
| check/run script.
|-
| verify
| [numberx] filename | function [parameters]
| check/run script.
|-
| version
|
| display KoLmafia version.
|}

==Scripting==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| <inline-ash-script>
|
| embed an ASH script in a CLI script.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| colorecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| echo
| timestamp | text
| include timestamp or text in the session log.
|-
| else
| ; commands
| do commands if preceding if/while/try didn't execute.
|-
| elseif
| condition; commands
| do if condition is true but preceding condition was false.
|-
| if
| condition; commands
| do commands once if condition is true (see condref).
|-
| [[using|namespace]]
| [filter]
| list namespace scripts and the functions they define.
|-
| pause
| [seconds]
| pause script execution (default 1 second).
|-
| try
| ; commands
| do commands, and continue even if an error occurs.
|-
| [[using]]
| filename
| add ASH script to namespace.
|-
| wait
| [seconds]
| pause script execution (default 1 second).
|-
| while
| condition; commands
| do commands repeatedly while condition is true.
|}

==Other==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| *.php*
|
| visit URL without showing results.
|-
| *mirror*
| [filename]
| stop [or start] logging to an additional file.
|-
| aa
| skill
| set default attack method.
|-
| [[PvP Commands|attack]]
| attack target [, target...]
| PvP for items or fame
|-
| autoattack
| skill
| set default attack method.
|-
| ballpit
|
| jump in your clan's awesome ball pit.
|-
| basement
|
| check Fernswarthy's Basement status.
|-
|-
| banishes
|
| display information about current banishes.
|-
| bounty
| [ easy | hard | special]
| List or optionally accept bounties of given difficulty
|-
| [[enthrone (CLI)|bjornify]][?]
| species
| place a familiar in the Buddy Bjorn.
|-
| burn
| extra | * | num | -num
| use excess/all/specified/all but specified MP for buff extension and summons.
|-
| [[camp]]*
| rest | etc. [numTimes]
| perform campground actions.
|-
| cast[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| chips
| type [,type [,type]]
| buy chips from your clan's snack machine: radium, ennui, wintergreen
|-
| clan
| [ snapshot | stashlog ]
| clan management.
|-
| coinmaster
| (buy | sell) nickname item [,item] ...
| buy or sell items to specified coinmaster.
|-
| crimbotree
| [ get ]
| check [or get present from] the Crimbo Tree in your clan's VIP lounge
|-
| csend
| item [, item]... to recipient [ || message ]
| send kmail
|-
| dad
|
| show the round-by-round elemental weaknesses of Dad Sea Monkee.
|-
| demons
|
| list the demon names you know.
|-
| donate
| boris | mus | jarl | mys | pete | mox amount
| donate in Hall of Legends.
|-
| drink[?]
| [either] item [, item]...
| use/consume items
|-
| effects
| [param]
| list indicated type of data, possibly filtered by param.
|-
| enable
| all | command [, command]...
| allow/deny CLI commands.
|-
| encounters
| [param]
| list indicated type of data, possibly filtered by param.
|-
| entity
|
| give details of your current pastamancer combat entity.
|-
| [[enthrone (CLI)|enthrone]][?]
| species
| place a familiar in the Crown of Thrones.
|-
| eudora
| penpal | game lock | xi
| switch to the specified correspondent
|-
| familiar[?]
| [list filter] | lock | unlock | species | none
| list or change familiar types
|-
| fax
| send | put | receive | get
| use the fax machine in your clan's VIP lounge
|-
| faxbot
| [command]
| send the command cmd to faxbot
|-
| field
| [ plant square type | pick square | harvest ]
| view or use your mushroom plot
|-
| [[PvP Commands|flowers]]
|
| commit random acts of PvP.
|-
| forum*
|
| visit the official KoL forums.
|-
| friars
| [blessing] food | familiar | booze
| get daily blessing.
|-
| galaktik
| (hp | mp) [amount]
| restore amount or all hp or mp
|-
| grim
| init | hpmp | damage
| get a Grim Brother buff
|-
| hiddencity
| square [temple | altar item]
| set Hidden City square [and perform an action there].
|-
| [[holiday]]
| HolidayName
| enable special processing for unpredicted holidays.
|-
| hottub
|
| soak in your clan's hot tub
|-
| http:*
|
| visit URL without showing results.
|-
| ingredients
| item [, item]...
| get ingredients or recipe for items
|-
| kmail
| item [, item]... to recipient [ || message ]
| send kmail
|-
| locations
| [param]
| list indicated type of data, possibly filtered by param.
|-
| lookup
| item | effect
| go to appropriate KoL Wiki page.
|-
| mcd
| number
| set mind control device (or equivalent) to new value.
|-
| mind-control
| number
| set mind control device (or equivalent) to new value.
|-
| moleref
|
| Path of the Mole spoilers.
|-
| monsters
| location
| show combat details for the specified area.
|-
| moon*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| mpitems
|
| counts MP restoratives in inventory.
|-
| nuns
| [mp]
| visit the Nunnery for restoration [but only if MP is restored].
|-
| olfact*
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[panda]]
| moan | temple | comedy type | arena bandmember item
| interact with NPCs in Pandamonium
|-
| pool
| type [,type [,type]]
| play pool games in your clan's VIP lounge
|-
| putty
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[PvP Commands|pvp]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| pvplog*
|
| summarize PvP results.
|-
| raffle
| ticketsToBuy [ inventory | storage ]
| buy raffle tickets
|-
| recipe
| item [, item]...
| get ingredients or recipe for items.
|-
| recover*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| remedy[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| restore*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| safe
| location
| show summary data for the specified area.
|-
| send
| item [, item]... to recipient [ || message ]
| send kmail
|-
| shower
| cold | ice | cool | moxie | lukewarm | mysticality | warm | muscle | hot | mp
| take a shower in your clan's VIP lounge
|-
| shrug[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| skeleton
| warrior | cleric | wizard | rogue | buddy
| Use a single skeleton and select from the choice adventure according to the parameter
|-
| skill[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| skills
| [param]
| list indicated type of data, possibly filtered by param.
|-
| sleep
| number
| rest on your clan sofa for number turns.
|-
| soak
|
| soak in your clan's VIP hot tub
|-
| sofa
| number
| rest on your clan sofa for number turns.
|-
| spade
| [prices URL]
| submit automatically gathered data.
|-
| status
| [param]
| list indicated type of data, possibly filtered by param.
|-
| [[PvP Commands|steal]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| styx
| muscle | mysticality | moxie
| get daily Styx Pixie buff.
|-
| summary
| [param]
| list indicated type of data, possibly filtered by param.
|-
| summon
| demonName | effect | location | number
| use the Summoning Chamber.
|-
| [[PvP Commands|swagger]]
|
| commit random acts of PvP.
|-
| swim
| laps | ml | sprints | noncombat
| work out in your clan's VIP lounge swimming pool
|-
| text
| URL
| show text results from visiting URL.
|-
| train
| base weight | buffed weight | turns number
| train familiar.
|-
| uneffect[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| unequip
| slot | name
| remove equipment in slot, or that matches name
|-
| up?
| effect [, effect]...
| extend duration of effects.
|-
| wiki
| searchText
| perform search on KoL Wiki.
|-
| win
| game
| I'm as surprised as you! I didn't think it was possible.
|}

==Developer==
None of these commands take arguments.
{| class="wikitable" border="1"
|-
! Command Name
! Added to KoLmafia
! Description
|-
| checkconsumption
| rXXXX
| description goes here
|-
| checkeffects
| r6966
| description goes here
|-
| checkfamiliars
| rXXXX
| description goes here
|-
| checkitems
| r6966
| description goes here
|-
| checkmodifiers
| r4640
| description goes here
|-
| checkoutfits
| r14949
| description goes here
|-
| checkplurals
| rXXXX
| description goes here
|-
| checkpotions
| r9791
| description goes here
|-
| checkpowers
| r9080
| description goes here
|-
| checkprofile
| r6539
| description goes here
|-
| checkpulverization
| rXXXX
| description goes here
|-
| checkshields
| r9091
| description goes here
|-
| checkzapgroups
| rXXXX
| description goes here
|}

[[Category:CLI Commands]]

Help:To Do List

2014-11-16T20:24:11Z

Wrldwzrd89: /* Missing Stuff */ Developer commands added

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==
r9181, 9183, 9184 & r9190: '''moods''' per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods

r11707: Experimental ASH feature: the main() function of imported scripts can now be
invoked, under the alternate name main@filename()
(where 'filename' can be overridden by a 'script' directive, any ".ash"
suffix is dropped, and non-alphanumeric characters are replaced by
underscores). Note that no spaces are allowed around the @, the whole thing
is a single token.

r12060: add ASH '''get_moods()''', returns an aggregate of currently defined mood names.
"mood listall" in the gCLI will also print a list of defined moods.

r12062: add ASH '''get_outfits()''' and get_custom_outfits()

r12238: Add _floristPlantsUsed as a comma-separated list and '''florist_available()'''.
Add "florist plant [plantname]" to add a plant. [plantname] is case-insensitive, but otherwise must exactly match KoL's name for the plant.
Check what is currently planted when you log in.

r12244: Add string [location][int] '''get_florist_plants()'''

example 1...
foreach loc, counter, plant in get_florist_plants() {
print( "Location '" + loc + "'" );
print( "Counter '" + counter + "'" );
print( "Plant '" + plant + "'" );
}

example 2...
string [location][int] plants = get_florist_plants();
foreach loc in plants {
print( "Location '" + loc + "'" );
string [int] array = plants[ loc ];
foreach index in array {
string plant = array[index];
if ( plant != "" )
print( "Plant = " + plant );
}
}

13213: Add "debug ash on" and "debug ash off" to turn on and off ASH script tracing
ASH tracing goes into ASH_datestamp.txt

13222: Add preference banishedMonsters to track banishes. Add ash command '''is_banished($monsterName[name])'''

13988: Start tracking elemental planes quests, Hidden Temple quest, Spookyraven Babies quest, from quest log.
questESlAudit
questESlBacteria
questESlCheeseburger
questESlCocktail
questESlDebt
questESlFish
questESlMushStash
questESlSalt
questESlSprinkles
questM16Temple
questM17Babies

r14729: add fixedThreadPoolSize pref - diagnostic/fine tuning for limiting the threadpool size.

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

CLI Reference

2014-11-16T20:23:18Z

Wrldwzrd89: Move checkXXX commands to new Developer section, add the rest of 'em

The KoLmafia Graphical CLI is one of the most helpful features Mafia has. This page is intended to provide information on the commands available.

=How to use these commands=

Square brackets [ ] enclose optional elements of commands. In command descriptions, they may also enclose the effects of using those optional elements.

Vertical bars | separate alternative elements - choose any one. (But note that || is an actual part of a few commands.)

An ellipsis ... after an element means that it can be repeated as many times as needed.

Elements in italics are placeholders - replace them with an actual name you want the command to operate on.

Commands with an asterisk * after the name are abbreviations - you can type them in a longer form if desired.

Some command names can be followed by a question mark (shown as [?] ), in which case the command will just display what it would do, rather than actually doing it.

When adventuring, or using an item or skill, the name can be preceded by a number specifying how many times to do it. An asterisk in place of this number means "as many as possible" or "the current quantity in inventory", depending on context. Negative numbers mean to do that many less than the maximum.

Usually, multiple commands can be given on the same line, separated by semicolons. The exceptions (alias, ash, ashq, cheapest, expensive, fecho, fprint, get, set, speculate, whatif, later) treat the entire remainder of the line as a parameter.

A few commands (elseif, else, if, try, while) treat at least one following command as a block that is executed conditionally or repetitively. The block consists of the remainder of the line, or the entire next line if that's empty. The block is extended by additional lines if it would otherwise end with one of these special commands.

===Quantity Parameter===
Any place that a number can be used to define a quantity, such as <code>autosell 5 heavy D</code>, you can use one of the following to indicate a variable quantity:
* <nowiki>*</nowiki> is used to indicate all items in inventory.
: <code>autosell * heavy D</code>
* 0 is also used to indicate all items in inventory.
: <code>autosell 0 heavy D</code>
* a negative number means sell off all items except for the number listed. For example, -5 means keep 5 and sell the rest.
: <code>autosell -5 heavy D</code>

===Item Parameter===
There are two ways to provide an item. By name or number.
* An item's name can be used in the obvious way, however this may sometimes fail because some items have numbers as part of their names. KoL's fuzzy matching will sometimes make a mistake such as interpreting {{Pspan|1 WA}} as a {{Pspan|100-watt light bulb}}.

* An item's ID number can be used to avoid any possibility of ambiguity. This also allows names with commas to be passed as parameters to functions that contain comma separated lists. To do this the item needs to be prefaced by a [http://en.wikipedia.org/wiki/Pilcrow pilcrow]. The character: ¶, is also known as a paragraph mark. It can be typed from your keyboard with a bit of know-how or included in an ash script as "\u00B6".
: <code>send 1 ¶4358 to Bale|Thanks for being awesome</code>
: is a way to send {{Pspan|A Crimbo Carol, Ch. 5}} to Bale despite the comma in the item's name.

=Commands=
==Equipment, Inventory and Consumption Management==
{| class="wikitable" border="1"
|-
! Command
! Arguments
! Description
|-
| *brewery*[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| *kitchen*[?]
| item
| consumes item at Hell's Kitchen, if available.
|-
| acquire
| item
| ensure that you have item, creating or buying it if needed.
|-
| accordions
|
| show information about accordions.
|-
| bake
| [ item... ]
| list creatables, or create specified items.
|-
| bjornify
| [familiar]
| list available familiars, or put a familiar in your {{kolwiki|Buddy Bjorn}}
|-
| chew[?]
| [either] item [, item]...
| use/consume items
|-
| cleanup
|
| use, pulverize, or autosell your junk items.
|-
| closet
| list ''filter'' | empty | put ''item''... | take ''item''...
| list or manipulate your closet.
|-
| create
| [ item... ]
| list creatables, or create specified items.
|-
| display
| [filter] | put item... | take item...
| list or manipulate your display case.
|-
| eat[?]
| [either] item [, item]...
| use/consume items
|-
| equip
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| find
| item
| ensure that you have item, creating or buying it if needed.
|-
| fold[?]
| item
| produce item by using another form, repeated as needed.
|-
| ghost[?]
| [either] item [, item]...
| use/consume items
|-
| hagnk
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| hermit[?]
| [item]
| get clover status, or trade for item.
|-
| hobo[?]
| [either] item [, item]...
| use/consume items
|-
| inv*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| junk
|
| use, pulverize, or autosell your junk items.
|-
| make
| [ item... ]
| list creatables, or create specified items.
|-
| maximize[?]
| [+|-|weight] keyword, ...
| run the [[Modifier Maximizer]].
|-
| mix
| [ item... ]
| list creatables, or create specified items.
|-
| modifies
| filter
| list all possible sources of modifiers matching filter.
|-
| [[Modifiers|modref]]
| [object]
| list all modifiers, show values for player [and object].
|-
| modtrace
| filter
| list everything that adds to modifiers matching filter.
|-
| outfit
| [list filter] | save name | checkpoint | name
| list, save, restore, or change outfits.
|-
| overdrink[?]
| [either] item [, item]...
| use/consume items
|-
| ply
| [ item... ]
| list creatables, or create specified items.
|-
| pull
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| pulverize
| item [, item]...
| pulverize specified items
|-
| quark[?]
| [itemList...]
| gain MP by pasting unstable quark with best item from itemList (or your junk list).
|-
| remove
| slot | name
| remove equipment in slot, or that matches name
|-
| restaurant[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| retrieve
| item
| ensure that you have item, creating or buying it if needed.
|-
| skeeball
| [count]
| squander Game Grid tokens at the broken Skeeball machine
|-
| slime-stack*
|
| show details of slime stacks disgorged by Slimeling
|-
| slimeling[?]
| [either] item [, item]...
| use/consume items
|-
| smash
| item [, item]...
| pulverize specified items
|-
| smith
| [ item... ]
| list creatables, or create specified items.
|-
| [[speculate]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| squeeze[?]
| item
| produce item by using another form, repeated as needed.
|-
| stash
| [put] item... | take item...
| exchange items with clan stash
|-
| sticker*
| sticker1 [, sticker2 [, sticker3]]
| replace worn stickers.
|-
| storage
| [param]
| list indicated type of data, possibly filtered by param.
|-
| tinker
| [ item... ]
| list creatables, or create specified items.
|-
| wear
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| [[whatif]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| wield
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| zap
| item [, item]...
| transform items with your wand.
|}

==Quests==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| !
|
| list the Dungeons of Doom potions you've identified.
|-
| bang
|
| list the Dungeons of Doom potions you've identified.
|-
| baron
|
| finds the baron in the Tavern.
|-
| bugbears
|
| List progress of {{kolwiki|Bugbear Invasion|bugbear hunting}}.
|-
| chamber
|
| automatically complete quest.
|-
| council
|
| visit the Council to advance quest progress.
|-
| dusty
|
| list the dusty bottles of wine you've identified.
|-
| entryway
| [clover]
| automatically complete quest [using a clover].
|-
| factory
| report digits
| Given a string of 7 dwarven digits, report on factory.
|-
| gourd
|
| automatically complete quest.
|-
| grandpa
| query
| Ask Grandpa about something.
|-
| guardians
|
| automatically complete quest.
|-
| guild
|
| automatically complete quest.
|-
| hedge*
|
| automatically complete quest.
|-
| insults
|
| list the pirate insult comebacks you know.
|-
| leaflet
| [nomagic] | location | command
| complete leaflet quest [without using magic words].
|-
| maze
|
| automatically complete quest.
|-
| nemesis
|
| automatically complete quest.
|-
| poolskill
|
| calculates your current pool skill
|-
| spookyraven
| [on | off]
| when enabled, tracks Lights Out all the time
|-
| tavern
|
| automatically complete quest.
|-
| telescope
| [look] high | low
| get daily buff, or Lair hints from your telescope.
|-
| tower
|
| automatically complete quest.
|}

==Capitalism==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| automall
|
| dump all profitable, non-memento items into the Mall.
|-
| autosell
| item [, item]...
| autosell items.
|-
| buy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| cheapest[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| expensive[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| mallbuy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| mallsell
| item [[@] price [[limit] num]] [, another]...
| sell in Mall.
|-
| reprice
|
| price all max-priced items at or below current Mall minimum price.
|-
| searchmall
| item [ with limit number ]
| search the Mall.
|-
| sell
| item [, item]...
| autosell items.
|-
| shop
| put item [[@] price [[limit] num]] [, another] | take [all] item [, another]
| put item into the mall or take from from mall.
|-
| undercut
|
| price all max-priced items at or below current Mall minimum price.
|-
| untinker
| [ item... ]
| complete quest, or untinker items.
|-
| use[?]
| [either] item [, item]...
| use/consume items
|}

==Mafia==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| adv*[?]
| last | [count] location
| spend your turns.
|-
| abort
| [message]
| stop current script or automated task.
|-
| [[alias]]
| [ word => expansion ]
| list or create CLI abbreviations.
|-
| [[ash (CLI)|ash]]
| statement
| test a line of ASH code without having to edit a script.
|-
| [[ash (CLI)|ashq]]
| statement
| Like ash, but does not display the return value.
|-
| [[ashwiki]]
| searchText
| perform search on KoLmafia Wiki.
|-
| ashref
| [filter]
| summarize ASH built-in functions [matching filter].
|-
| backtrace
| text | off
| dump stack when a gCLI message or page URL matches text (case-sensitive).
|-
| breakfast
|
| perform start-of-day activities.
|-
| budget
| [number]
| show [or set] the number of budgeted Hagnk's pulls.
|-
| buffbot
| number
| run buffbot for number iterations.
|-
| cache
| [clear]
| get image cache status or clear cache.
|-
| call
| [numberx] filename | function [parameters]
| check/run script.
|-
| ccs
| [script]
| show [or select] Custom Combat Script in use.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| chat
|
| switch to tab or open window
|-
| check
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| checkpoint
|
| remembers current equipment, use "outfit checkpoint" to restore.
|-
| [[choice (CLI)|choice]]
| [number|text]
| list or choose choice adventure options.
|-
| [[choice (CLI)|choice-goal]]
|
| automatically complete quest.
|-
| clear
|
| clear CLI window.
|-
| cls
|
| clear CLI window.
|-
| [[condition]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| condref
|
| list conditions usable with if/while commands.
|-
| [[counters]]
| [ clear | add number [title img] ]
| show, clear, or add to current turn counters.
|-
| debug
| [on] | off
| start or stop logging of debugging data.
|-
| disable
| all | command [, command]...
| allow/deny CLI commands.
|-
| events
| [clear]
| clear or show recent events.
|-
| exec*
| [numberx] filename | function [parameters]
| check/run script.
|-
| exit
|
| logout and exit KoLmafia.
|-
| gc
|
| force Java garbage collection.
|-
| garden
| [pick]
| get status of garden, or harvest it.
|-
| gear
|
| switch to tab or open window
|-
| get
| preference [ = value ]
| show/change preference settings
|-
| [[goal]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| graygui
| [force]
| print out a stack trace to help figure out why the UI might be gray/stuck (requires use of the JDK instead of the JRE).
|-
| greygui
|
| same as graygui
|-
| hatter
| [hat]
| List effects you can get by wearing available hats at the hatter's tea party. If parameter is provided, get the buff for that hat. (Using a potion if necessary.)
|-
| help
| [filter]
| list CLI commands [that match filter].
|-
| item
|
| switch to tab or open window
|-
| [jukebox]
| song
| listen to a song on your clan's jukebox.
|-
| later
| commands
| adds a button to do commands to the Daily Deeds list.
|-
| load
| [numberx] filename | function [parameters]
| check/run script.
|-
| location
| snarfblat loc
| Adds a new location named loc with the snarfblat number specified. This does not persist across session.
|-
| log
| [status],[equipment],[effects],[etc.]
| record data, "log snapshot" for all common data.
|-
| logecho
| timestamp | text
| include timestamp or text in the session log only.
|-
| login
| username
| logout then log back in as username.
|-
| logout
|
| logout and return to login window.
|-
| logprint
| timestamp | text
| include timestamp or text in the session log only.
|-
| mail
|
| switch to tab or open window
|-
| mood*
| list | listall | clear | autofill | execute | repeat [numTimes] | moodName [numTimes]
| mood management.
|-
| neweffect
| effect description ID
| learn a new effect (add to database override)
|-
| [[objective]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| opt*
|
| switch to tab or open window
|-
| print
| timestamp | text
| include timestamp or text in the session log.
|-
| priphea
|
| launch KoLmafia GUI.
|-
| quit
|
| logout and exit KoLmafia.
|-
| radio
|
| switch to tab or open window
|-
| relay
|
| open the relay browser.
|-
| refresh
| all | status | equip | inv | storage | familiar | stickers
| resynchronize with KoL.
|-
| repeat
| [number]
| repeat previous line [number times].
|-
| restores
| [all | obtainable]
| List details of restores. (current, all or obtainable)
|-
| run
| [numberx] filename | function [parameters]
| check/run script.
|-
| save
| as mood
| add your current effects to the mood.
|-
| session
| [param]
| list indicated type of data, possibly filtered by param.
|-
| set
| preference [ = value ]
| show/change preference settings
|-
| start
| [numberx] filename | function [parameters]
| check/run script.
|-
| [[Svn#CLI_Commands|svn]]
| heckout ''svnurl'' | update [''svnurl''] | list | delete ''project'' | sync
| install/update/manage svn ''projects''.
|-
| [[trigger]]*
| clear | autofill | [type,] effect [, action]
| edit current mood. Options for type are gain_effect, lose_effect, unconditional
|-
| unalias
| word
| remove a CLI abbreviation.
|-
| update
| data | clear | prices URL or filename
| download most recent data files, or revert to built-in data.
|-
| validate
| [numberx] filename | function [parameters]
| check/run script.
|-
| verify
| [numberx] filename | function [parameters]
| check/run script.
|-
| version
|
| display KoLmafia version.
|}

==Scripting==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| <inline-ash-script>
|
| embed an ASH script in a CLI script.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| colorecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| echo
| timestamp | text
| include timestamp or text in the session log.
|-
| else
| ; commands
| do commands if preceding if/while/try didn't execute.
|-
| elseif
| condition; commands
| do if condition is true but preceding condition was false.
|-
| if
| condition; commands
| do commands once if condition is true (see condref).
|-
| [[using|namespace]]
| [filter]
| list namespace scripts and the functions they define.
|-
| pause
| [seconds]
| pause script execution (default 1 second).
|-
| try
| ; commands
| do commands, and continue even if an error occurs.
|-
| [[using]]
| filename
| add ASH script to namespace.
|-
| wait
| [seconds]
| pause script execution (default 1 second).
|-
| while
| condition; commands
| do commands repeatedly while condition is true.
|}

==Other==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| *.php*
|
| visit URL without showing results.
|-
| *mirror*
| [filename]
| stop [or start] logging to an additional file.
|-
| aa
| skill
| set default attack method.
|-
| [[PvP Commands|attack]]
| attack target [, target...]
| PvP for items or fame
|-
| autoattack
| skill
| set default attack method.
|-
| ballpit
|
| jump in your clan's awesome ball pit.
|-
| basement
|
| check Fernswarthy's Basement status.
|-
|-
| banishes
|
| display information about current banishes.
|-
| bounty
| [ easy | hard | special]
| List or optionally accept bounties of given difficulty
|-
| [[enthrone (CLI)|bjornify]][?]
| species
| place a familiar in the Buddy Bjorn.
|-
| burn
| extra | * | num | -num
| use excess/all/specified/all but specified MP for buff extension and summons.
|-
| [[camp]]*
| rest | etc. [numTimes]
| perform campground actions.
|-
| cast[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| chips
| type [,type [,type]]
| buy chips from your clan's snack machine: radium, ennui, wintergreen
|-
| clan
| [ snapshot | stashlog ]
| clan management.
|-
| coinmaster
| (buy | sell) nickname item [,item] ...
| buy or sell items to specified coinmaster.
|-
| crimbotree
| [ get ]
| check [or get present from] the Crimbo Tree in your clan's VIP lounge
|-
| csend
| item [, item]... to recipient [ || message ]
| send kmail
|-
| dad
|
| show the round-by-round elemental weaknesses of Dad Sea Monkee.
|-
| demons
|
| list the demon names you know.
|-
| donate
| boris | mus | jarl | mys | pete | mox amount
| donate in Hall of Legends.
|-
| drink[?]
| [either] item [, item]...
| use/consume items
|-
| effects
| [param]
| list indicated type of data, possibly filtered by param.
|-
| enable
| all | command [, command]...
| allow/deny CLI commands.
|-
| encounters
| [param]
| list indicated type of data, possibly filtered by param.
|-
| entity
|
| give details of your current pastamancer combat entity.
|-
| [[enthrone (CLI)|enthrone]][?]
| species
| place a familiar in the Crown of Thrones.
|-
| eudora
| penpal | game lock | xi
| switch to the specified correspondent
|-
| familiar[?]
| [list filter] | lock | unlock | species | none
| list or change familiar types
|-
| fax
| send | put | receive | get
| use the fax machine in your clan's VIP lounge
|-
| faxbot
| [command]
| send the command cmd to faxbot
|-
| field
| [ plant square type | pick square | harvest ]
| view or use your mushroom plot
|-
| [[PvP Commands|flowers]]
|
| commit random acts of PvP.
|-
| forum*
|
| visit the official KoL forums.
|-
| friars
| [blessing] food | familiar | booze
| get daily blessing.
|-
| galaktik
| (hp | mp) [amount]
| restore amount or all hp or mp
|-
| grim
| init | hpmp | damage
| get a Grim Brother buff
|-
| hiddencity
| square [temple | altar item]
| set Hidden City square [and perform an action there].
|-
| [[holiday]]
| HolidayName
| enable special processing for unpredicted holidays.
|-
| hottub
|
| soak in your clan's hot tub
|-
| http:*
|
| visit URL without showing results.
|-
| ingredients
| item [, item]...
| get ingredients or recipe for items
|-
| kmail
| item [, item]... to recipient [ || message ]
| send kmail
|-
| locations
| [param]
| list indicated type of data, possibly filtered by param.
|-
| lookup
| item | effect
| go to appropriate KoL Wiki page.
|-
| mcd
| number
| set mind control device (or equivalent) to new value.
|-
| mind-control
| number
| set mind control device (or equivalent) to new value.
|-
| moleref
|
| Path of the Mole spoilers.
|-
| monsters
| location
| show combat details for the specified area.
|-
| moon*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| mpitems
|
| counts MP restoratives in inventory.
|-
| nuns
| [mp]
| visit the Nunnery for restoration [but only if MP is restored].
|-
| olfact*
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[panda]]
| moan | temple | comedy type | arena bandmember item
| interact with NPCs in Pandamonium
|-
| pool
| type [,type [,type]]
| play pool games in your clan's VIP lounge
|-
| putty
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[PvP Commands|pvp]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| pvplog*
|
| summarize PvP results.
|-
| raffle
| ticketsToBuy [ inventory | storage ]
| buy raffle tickets
|-
| recipe
| item [, item]...
| get ingredients or recipe for items.
|-
| recover*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| remedy[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| restore*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| safe
| location
| show summary data for the specified area.
|-
| send
| item [, item]... to recipient [ || message ]
| send kmail
|-
| shower
| cold | ice | cool | moxie | lukewarm | mysticality | warm | muscle | hot | mp
| take a shower in your clan's VIP lounge
|-
| shrug[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| skeleton
| warrior | cleric | wizard | rogue | buddy
| Use a single skeleton and select from the choice adventure according to the parameter
|-
| skill[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| skills
| [param]
| list indicated type of data, possibly filtered by param.
|-
| sleep
| number
| rest on your clan sofa for number turns.
|-
| soak
|
| soak in your clan's VIP hot tub
|-
| sofa
| number
| rest on your clan sofa for number turns.
|-
| spade
| [prices URL]
| submit automatically gathered data.
|-
| status
| [param]
| list indicated type of data, possibly filtered by param.
|-
| [[PvP Commands|steal]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| styx
| muscle | mysticality | moxie
| get daily Styx Pixie buff.
|-
| summary
| [param]
| list indicated type of data, possibly filtered by param.
|-
| summon
| demonName | effect | location | number
| use the Summoning Chamber.
|-
| [[PvP Commands|swagger]]
|
| commit random acts of PvP.
|-
| swim
| laps | ml | sprints | noncombat
| work out in your clan's VIP lounge swimming pool
|-
| text
| URL
| show text results from visiting URL.
|-
| train
| base weight | buffed weight | turns number
| train familiar.
|-
| uneffect[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| unequip
| slot | name
| remove equipment in slot, or that matches name
|-
| up?
| effect [, effect]...
| extend duration of effects.
|-
| wiki
| searchText
| perform search on KoL Wiki.
|-
| win
| game
| I'm as surprised as you! I didn't think it was possible.
|}

==Developer==
None of these commands take arguments.
{| class="wikitable" border="1"
|-
! Command Name
! Added to KoLmafia
! Description
|-
| checkconsumption
| rXXXX
| description goes here
|-
| checkeffects
| rXXXX
| description goes here
|-
| checkfamiliars
| rXXXX
| description goes here
|-
| checkitems
| rXXXX
| description goes here
|-
| checkmodifiers
| rXXXX
| description goes here
|-
| checkoutfits
| rXXXX
| description goes here
|-
| checkplurals
| rXXXX
| description goes here
|-
| checkpotions
| rXXXX
| description goes here
|-
| checkpowers
| rXXXX
| description goes here
|-
| checkprofile
| rXXXX
| description goes here
|-
| checkpulverization
| rXXXX
| description goes here
|-
| checkshields
| rXXXX
| description goes here
|-
| checkzapgroups
| rXXXX
| description goes here
|}

[[Category:CLI Commands]]

CLI Reference

2014-11-16T20:11:23Z

Wrldwzrd89: /* Mafia */ Add checkeffects, checkoutfits, and checkpowers

The KoLmafia Graphical CLI is one of the most helpful features Mafia has. This page is intended to provide information on the commands available.

=How to use these commands=

Square brackets [ ] enclose optional elements of commands. In command descriptions, they may also enclose the effects of using those optional elements.

Vertical bars | separate alternative elements - choose any one. (But note that || is an actual part of a few commands.)

An ellipsis ... after an element means that it can be repeated as many times as needed.

Elements in italics are placeholders - replace them with an actual name you want the command to operate on.

Commands with an asterisk * after the name are abbreviations - you can type them in a longer form if desired.

Some command names can be followed by a question mark (shown as [?] ), in which case the command will just display what it would do, rather than actually doing it.

When adventuring, or using an item or skill, the name can be preceded by a number specifying how many times to do it. An asterisk in place of this number means "as many as possible" or "the current quantity in inventory", depending on context. Negative numbers mean to do that many less than the maximum.

Usually, multiple commands can be given on the same line, separated by semicolons. The exceptions (alias, ash, ashq, cheapest, expensive, fecho, fprint, get, set, speculate, whatif, later) treat the entire remainder of the line as a parameter.

A few commands (elseif, else, if, try, while) treat at least one following command as a block that is executed conditionally or repetitively. The block consists of the remainder of the line, or the entire next line if that's empty. The block is extended by additional lines if it would otherwise end with one of these special commands.

===Quantity Parameter===
Any place that a number can be used to define a quantity, such as <code>autosell 5 heavy D</code>, you can use one of the following to indicate a variable quantity:
* <nowiki>*</nowiki> is used to indicate all items in inventory.
: <code>autosell * heavy D</code>
* 0 is also used to indicate all items in inventory.
: <code>autosell 0 heavy D</code>
* a negative number means sell off all items except for the number listed. For example, -5 means keep 5 and sell the rest.
: <code>autosell -5 heavy D</code>

===Item Parameter===
There are two ways to provide an item. By name or number.
* An item's name can be used in the obvious way, however this may sometimes fail because some items have numbers as part of their names. KoL's fuzzy matching will sometimes make a mistake such as interpreting {{Pspan|1 WA}} as a {{Pspan|100-watt light bulb}}.

* An item's ID number can be used to avoid any possibility of ambiguity. This also allows names with commas to be passed as parameters to functions that contain comma separated lists. To do this the item needs to be prefaced by a [http://en.wikipedia.org/wiki/Pilcrow pilcrow]. The character: ¶, is also known as a paragraph mark. It can be typed from your keyboard with a bit of know-how or included in an ash script as "\u00B6".
: <code>send 1 ¶4358 to Bale|Thanks for being awesome</code>
: is a way to send {{Pspan|A Crimbo Carol, Ch. 5}} to Bale despite the comma in the item's name.

=Commands=
==Equipment, Inventory and Consumption Management==
{| class="wikitable" border="1"
|-
! Command
! Arguments
! Description
|-
| *brewery*[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| *kitchen*[?]
| item
| consumes item at Hell's Kitchen, if available.
|-
| acquire
| item
| ensure that you have item, creating or buying it if needed.
|-
| accordions
|
| show information about accordions.
|-
| bake
| [ item... ]
| list creatables, or create specified items.
|-
| bjornify
| [familiar]
| list available familiars, or put a familiar in your {{kolwiki|Buddy Bjorn}}
|-
| chew[?]
| [either] item [, item]...
| use/consume items
|-
| cleanup
|
| use, pulverize, or autosell your junk items.
|-
| closet
| list ''filter'' | empty | put ''item''... | take ''item''...
| list or manipulate your closet.
|-
| create
| [ item... ]
| list creatables, or create specified items.
|-
| display
| [filter] | put item... | take item...
| list or manipulate your display case.
|-
| eat[?]
| [either] item [, item]...
| use/consume items
|-
| equip
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| find
| item
| ensure that you have item, creating or buying it if needed.
|-
| fold[?]
| item
| produce item by using another form, repeated as needed.
|-
| ghost[?]
| [either] item [, item]...
| use/consume items
|-
| hagnk
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| hermit[?]
| [item]
| get clover status, or trade for item.
|-
| hobo[?]
| [either] item [, item]...
| use/consume items
|-
| inv*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| junk
|
| use, pulverize, or autosell your junk items.
|-
| make
| [ item... ]
| list creatables, or create specified items.
|-
| maximize[?]
| [+|-|weight] keyword, ...
| run the [[Modifier Maximizer]].
|-
| mix
| [ item... ]
| list creatables, or create specified items.
|-
| modifies
| filter
| list all possible sources of modifiers matching filter.
|-
| [[Modifiers|modref]]
| [object]
| list all modifiers, show values for player [and object].
|-
| modtrace
| filter
| list everything that adds to modifiers matching filter.
|-
| outfit
| [list filter] | save name | checkpoint | name
| list, save, restore, or change outfits.
|-
| overdrink[?]
| [either] item [, item]...
| use/consume items
|-
| ply
| [ item... ]
| list creatables, or create specified items.
|-
| pull
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| pulverize
| item [, item]...
| pulverize specified items
|-
| quark[?]
| [itemList...]
| gain MP by pasting unstable quark with best item from itemList (or your junk list).
|-
| remove
| slot | name
| remove equipment in slot, or that matches name
|-
| restaurant[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| retrieve
| item
| ensure that you have item, creating or buying it if needed.
|-
| skeeball
| [count]
| squander Game Grid tokens at the broken Skeeball machine
|-
| slime-stack*
|
| show details of slime stacks disgorged by Slimeling
|-
| slimeling[?]
| [either] item [, item]...
| use/consume items
|-
| smash
| item [, item]...
| pulverize specified items
|-
| smith
| [ item... ]
| list creatables, or create specified items.
|-
| [[speculate]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| squeeze[?]
| item
| produce item by using another form, repeated as needed.
|-
| stash
| [put] item... | take item...
| exchange items with clan stash
|-
| sticker*
| sticker1 [, sticker2 [, sticker3]]
| replace worn stickers.
|-
| storage
| [param]
| list indicated type of data, possibly filtered by param.
|-
| tinker
| [ item... ]
| list creatables, or create specified items.
|-
| wear
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| [[whatif]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| wield
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| zap
| item [, item]...
| transform items with your wand.
|}

==Quests==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| !
|
| list the Dungeons of Doom potions you've identified.
|-
| bang
|
| list the Dungeons of Doom potions you've identified.
|-
| baron
|
| finds the baron in the Tavern.
|-
| bugbears
|
| List progress of {{kolwiki|Bugbear Invasion|bugbear hunting}}.
|-
| chamber
|
| automatically complete quest.
|-
| council
|
| visit the Council to advance quest progress.
|-
| dusty
|
| list the dusty bottles of wine you've identified.
|-
| entryway
| [clover]
| automatically complete quest [using a clover].
|-
| factory
| report digits
| Given a string of 7 dwarven digits, report on factory.
|-
| gourd
|
| automatically complete quest.
|-
| grandpa
| query
| Ask Grandpa about something.
|-
| guardians
|
| automatically complete quest.
|-
| guild
|
| automatically complete quest.
|-
| hedge*
|
| automatically complete quest.
|-
| insults
|
| list the pirate insult comebacks you know.
|-
| leaflet
| [nomagic] | location | command
| complete leaflet quest [without using magic words].
|-
| maze
|
| automatically complete quest.
|-
| nemesis
|
| automatically complete quest.
|-
| poolskill
|
| calculates your current pool skill
|-
| spookyraven
| [on | off]
| when enabled, tracks Lights Out all the time
|-
| tavern
|
| automatically complete quest.
|-
| telescope
| [look] high | low
| get daily buff, or Lair hints from your telescope.
|-
| tower
|
| automatically complete quest.
|}

==Capitalism==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| automall
|
| dump all profitable, non-memento items into the Mall.
|-
| autosell
| item [, item]...
| autosell items.
|-
| buy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| cheapest[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| expensive[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| mallbuy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| mallsell
| item [[@] price [[limit] num]] [, another]...
| sell in Mall.
|-
| reprice
|
| price all max-priced items at or below current Mall minimum price.
|-
| searchmall
| item [ with limit number ]
| search the Mall.
|-
| sell
| item [, item]...
| autosell items.
|-
| shop
| put item [[@] price [[limit] num]] [, another] | take [all] item [, another]
| put item into the mall or take from from mall.
|-
| undercut
|
| price all max-priced items at or below current Mall minimum price.
|-
| untinker
| [ item... ]
| complete quest, or untinker items.
|-
| use[?]
| [either] item [, item]...
| use/consume items
|}

==Mafia==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| adv*[?]
| last | [count] location
| spend your turns.
|-
| abort
| [message]
| stop current script or automated task.
|-
| [[alias]]
| [ word => expansion ]
| list or create CLI abbreviations.
|-
| [[ash (CLI)|ash]]
| statement
| test a line of ASH code without having to edit a script.
|-
| [[ash (CLI)|ashq]]
| statement
| Like ash, but does not display the return value.
|-
| [[ashwiki]]
| searchText
| perform search on KoLmafia Wiki.
|-
| ashref
| [filter]
| summarize ASH built-in functions [matching filter].
|-
| backtrace
| text | off
| dump stack when a gCLI message or page URL matches text (case-sensitive).
|-
| breakfast
|
| perform start-of-day activities.
|-
| budget
| [number]
| show [or set] the number of budgeted Hagnk's pulls.
|-
| buffbot
| number
| run buffbot for number iterations.
|-
| cache
| [clear]
| get image cache status or clear cache.
|-
| call
| [numberx] filename | function [parameters]
| check/run script.
|-
| ccs
| [script]
| show [or select] Custom Combat Script in use.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| chat
|
| switch to tab or open window
|-
| check
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| checkeffects
|
| Verifies that all effects have the correct modifiers defined in KoLmafia's data.
|-
| checkoutfits
|
| Verifies that all outfits have the correct modifiers defined in KoLmafia's data.
|-
| checkpoint
|
| remembers current equipment, use "outfit checkpoint" to restore.
|-
| checkpowers
|
| Verifies that equipment you possess has the correct power defined in KoLmafia's data.
|-
| [[choice (CLI)|choice]]
| [number|text]
| list or choose choice adventure options.
|-
| [[choice (CLI)|choice-goal]]
|
| automatically complete quest.
|-
| clear
|
| clear CLI window.
|-
| cls
|
| clear CLI window.
|-
| [[condition]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| condref
|
| list conditions usable with if/while commands.
|-
| [[counters]]
| [ clear | add number [title img] ]
| show, clear, or add to current turn counters.
|-
| debug
| [on] | off
| start or stop logging of debugging data.
|-
| disable
| all | command [, command]...
| allow/deny CLI commands.
|-
| events
| [clear]
| clear or show recent events.
|-
| exec*
| [numberx] filename | function [parameters]
| check/run script.
|-
| exit
|
| logout and exit KoLmafia.
|-
| gc
|
| force Java garbage collection.
|-
| garden
| [pick]
| get status of garden, or harvest it.
|-
| gear
|
| switch to tab or open window
|-
| get
| preference [ = value ]
| show/change preference settings
|-
| [[goal]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| graygui
| [force]
| print out a stack trace to help figure out why the UI might be gray/stuck (requires use of the JDK instead of the JRE).
|-
| greygui
|
| same as graygui
|-
| hatter
| [hat]
| List effects you can get by wearing available hats at the hatter's tea party. If parameter is provided, get the buff for that hat. (Using a potion if necessary.)
|-
| help
| [filter]
| list CLI commands [that match filter].
|-
| item
|
| switch to tab or open window
|-
| [jukebox]
| song
| listen to a song on your clan's jukebox.
|-
| later
| commands
| adds a button to do commands to the Daily Deeds list.
|-
| load
| [numberx] filename | function [parameters]
| check/run script.
|-
| location
| snarfblat loc
| Adds a new location named loc with the snarfblat number specified. This does not persist across session.
|-
| log
| [status],[equipment],[effects],[etc.]
| record data, "log snapshot" for all common data.
|-
| logecho
| timestamp | text
| include timestamp or text in the session log only.
|-
| login
| username
| logout then log back in as username.
|-
| logout
|
| logout and return to login window.
|-
| logprint
| timestamp | text
| include timestamp or text in the session log only.
|-
| mail
|
| switch to tab or open window
|-
| mood*
| list | listall | clear | autofill | execute | repeat [numTimes] | moodName [numTimes]
| mood management.
|-
| neweffect
| effect description ID
| learn a new effect (add to database override)
|-
| [[objective]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| opt*
|
| switch to tab or open window
|-
| print
| timestamp | text
| include timestamp or text in the session log.
|-
| priphea
|
| launch KoLmafia GUI.
|-
| quit
|
| logout and exit KoLmafia.
|-
| radio
|
| switch to tab or open window
|-
| relay
|
| open the relay browser.
|-
| refresh
| all | status | equip | inv | storage | familiar | stickers
| resynchronize with KoL.
|-
| repeat
| [number]
| repeat previous line [number times].
|-
| restores
| [all | obtainable]
| List details of restores. (current, all or obtainable)
|-
| run
| [numberx] filename | function [parameters]
| check/run script.
|-
| save
| as mood
| add your current effects to the mood.
|-
| session
| [param]
| list indicated type of data, possibly filtered by param.
|-
| set
| preference [ = value ]
| show/change preference settings
|-
| start
| [numberx] filename | function [parameters]
| check/run script.
|-
| [[Svn#CLI_Commands|svn]]
| heckout ''svnurl'' | update [''svnurl''] | list | delete ''project'' | sync
| install/update/manage svn ''projects''.
|-
| [[trigger]]*
| clear | autofill | [type,] effect [, action]
| edit current mood. Options for type are gain_effect, lose_effect, unconditional
|-
| unalias
| word
| remove a CLI abbreviation.
|-
| update
| data | clear | prices URL or filename
| download most recent data files, or revert to built-in data.
|-
| validate
| [numberx] filename | function [parameters]
| check/run script.
|-
| verify
| [numberx] filename | function [parameters]
| check/run script.
|-
| version
|
| display KoLmafia version.
|}

==Scripting==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| <inline-ash-script>
|
| embed an ASH script in a CLI script.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| colorecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| echo
| timestamp | text
| include timestamp or text in the session log.
|-
| else
| ; commands
| do commands if preceding if/while/try didn't execute.
|-
| elseif
| condition; commands
| do if condition is true but preceding condition was false.
|-
| if
| condition; commands
| do commands once if condition is true (see condref).
|-
| [[using|namespace]]
| [filter]
| list namespace scripts and the functions they define.
|-
| pause
| [seconds]
| pause script execution (default 1 second).
|-
| try
| ; commands
| do commands, and continue even if an error occurs.
|-
| [[using]]
| filename
| add ASH script to namespace.
|-
| wait
| [seconds]
| pause script execution (default 1 second).
|-
| while
| condition; commands
| do commands repeatedly while condition is true.
|}

==Other==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| *.php*
|
| visit URL without showing results.
|-
| *mirror*
| [filename]
| stop [or start] logging to an additional file.
|-
| aa
| skill
| set default attack method.
|-
| [[PvP Commands|attack]]
| attack target [, target...]
| PvP for items or fame
|-
| autoattack
| skill
| set default attack method.
|-
| ballpit
|
| jump in your clan's awesome ball pit.
|-
| basement
|
| check Fernswarthy's Basement status.
|-
|-
| banishes
|
| display information about current banishes.
|-
| bounty
| [ easy | hard | special]
| List or optionally accept bounties of given difficulty
|-
| [[enthrone (CLI)|bjornify]][?]
| species
| place a familiar in the Buddy Bjorn.
|-
| burn
| extra | * | num | -num
| use excess/all/specified/all but specified MP for buff extension and summons.
|-
| [[camp]]*
| rest | etc. [numTimes]
| perform campground actions.
|-
| cast[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| chips
| type [,type [,type]]
| buy chips from your clan's snack machine: radium, ennui, wintergreen
|-
| clan
| [ snapshot | stashlog ]
| clan management.
|-
| coinmaster
| (buy | sell) nickname item [,item] ...
| buy or sell items to specified coinmaster.
|-
| crimbotree
| [ get ]
| check [or get present from] the Crimbo Tree in your clan's VIP lounge
|-
| csend
| item [, item]... to recipient [ || message ]
| send kmail
|-
| dad
|
| show the round-by-round elemental weaknesses of Dad Sea Monkee.
|-
| demons
|
| list the demon names you know.
|-
| donate
| boris | mus | jarl | mys | pete | mox amount
| donate in Hall of Legends.
|-
| drink[?]
| [either] item [, item]...
| use/consume items
|-
| effects
| [param]
| list indicated type of data, possibly filtered by param.
|-
| enable
| all | command [, command]...
| allow/deny CLI commands.
|-
| encounters
| [param]
| list indicated type of data, possibly filtered by param.
|-
| entity
|
| give details of your current pastamancer combat entity.
|-
| [[enthrone (CLI)|enthrone]][?]
| species
| place a familiar in the Crown of Thrones.
|-
| eudora
| penpal | game lock | xi
| switch to the specified correspondent
|-
| familiar[?]
| [list filter] | lock | unlock | species | none
| list or change familiar types
|-
| fax
| send | put | receive | get
| use the fax machine in your clan's VIP lounge
|-
| faxbot
| [command]
| send the command cmd to faxbot
|-
| field
| [ plant square type | pick square | harvest ]
| view or use your mushroom plot
|-
| [[PvP Commands|flowers]]
|
| commit random acts of PvP.
|-
| forum*
|
| visit the official KoL forums.
|-
| friars
| [blessing] food | familiar | booze
| get daily blessing.
|-
| galaktik
| (hp | mp) [amount]
| restore amount or all hp or mp
|-
| grim
| init | hpmp | damage
| get a Grim Brother buff
|-
| hiddencity
| square [temple | altar item]
| set Hidden City square [and perform an action there].
|-
| [[holiday]]
| HolidayName
| enable special processing for unpredicted holidays.
|-
| hottub
|
| soak in your clan's hot tub
|-
| http:*
|
| visit URL without showing results.
|-
| ingredients
| item [, item]...
| get ingredients or recipe for items
|-
| kmail
| item [, item]... to recipient [ || message ]
| send kmail
|-
| locations
| [param]
| list indicated type of data, possibly filtered by param.
|-
| lookup
| item | effect
| go to appropriate KoL Wiki page.
|-
| mcd
| number
| set mind control device (or equivalent) to new value.
|-
| mind-control
| number
| set mind control device (or equivalent) to new value.
|-
| moleref
|
| Path of the Mole spoilers.
|-
| monsters
| location
| show combat details for the specified area.
|-
| moon*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| mpitems
|
| counts MP restoratives in inventory.
|-
| nuns
| [mp]
| visit the Nunnery for restoration [but only if MP is restored].
|-
| olfact*
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[panda]]
| moan | temple | comedy type | arena bandmember item
| interact with NPCs in Pandamonium
|-
| pool
| type [,type [,type]]
| play pool games in your clan's VIP lounge
|-
| putty
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| [[PvP Commands|pvp]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| pvplog*
|
| summarize PvP results.
|-
| raffle
| ticketsToBuy [ inventory | storage ]
| buy raffle tickets
|-
| recipe
| item [, item]...
| get ingredients or recipe for items.
|-
| recover*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| remedy[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| restore*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| safe
| location
| show summary data for the specified area.
|-
| send
| item [, item]... to recipient [ || message ]
| send kmail
|-
| shower
| cold | ice | cool | moxie | lukewarm | mysticality | warm | muscle | hot | mp
| take a shower in your clan's VIP lounge
|-
| shrug[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| skeleton
| warrior | cleric | wizard | rogue | buddy
| Use a single skeleton and select from the choice adventure according to the parameter
|-
| skill[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| skills
| [param]
| list indicated type of data, possibly filtered by param.
|-
| sleep
| number
| rest on your clan sofa for number turns.
|-
| soak
|
| soak in your clan's VIP hot tub
|-
| sofa
| number
| rest on your clan sofa for number turns.
|-
| spade
| [prices URL]
| submit automatically gathered data.
|-
| status
| [param]
| list indicated type of data, possibly filtered by param.
|-
| [[PvP Commands|steal]]
| [attacks] ( flowers | loot | fame ) [muscle|myst|moxie|ballyhoo]
| commit random acts of PvP [using the specified stance].
|-
| styx
| muscle | mysticality | moxie
| get daily Styx Pixie buff.
|-
| summary
| [param]
| list indicated type of data, possibly filtered by param.
|-
| summon
| demonName | effect | location | number
| use the Summoning Chamber.
|-
| [[PvP Commands|swagger]]
|
| commit random acts of PvP.
|-
| swim
| laps | ml | sprints | noncombat
| work out in your clan's VIP lounge swimming pool
|-
| text
| URL
| show text results from visiting URL.
|-
| train
| base weight | buffed weight | turns number
| train familiar.
|-
| uneffect[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| unequip
| slot | name
| remove equipment in slot, or that matches name
|-
| up?
| effect [, effect]...
| extend duration of effects.
|-
| wiki
| searchText
| perform search on KoL Wiki.
|-
| win
| game
| I'm as surprised as you! I didn't think it was possible.
|}

[[Category:CLI Commands]]