CLI Reference
Revision as of 04:58, 1 October 2009 by imported>Bale (→Mafia)
The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.
Equipment, Inventory and Consumption Management
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. |
bake | [ item... ] | list creatables, or create specified items. |
chew[?] | [either] item [, item]... | use/consume items |
cleanup | use, pulverize, or autosell your junk items. | |
closet | take item... | list or manipulate your closet. |
create | [ item... ] | list creatables, or create specified items. |
display | 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. |
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. |
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 | 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
Command Name | Arguments | Description |
---|---|---|
! | list the Dungeons of Doom potions you've identified. | |
bang | list the Dungeons of Doom potions you've identified. | |
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 | command | complete leaflet quest [without using magic words]. |
maze | automatically complete quest. | |
nemesis | automatically complete quest. | |
tavern | automatically complete quest. | |
telescope | [look] high | low | get daily buff, or Lair hints from your telescope. |
tower | automatically complete quest. |
Capitalism
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. |
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
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 | statement | test a line of ASH code without having to edit a script. |
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. |
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. | |
clear | clear CLI window. | |
cls | clear CLI window. | |
condition* | 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. | |
gear | switch to tab or open window | |
get | preference [ = value ] | show/change preference settings |
goal* | add condition | set condition | modify your adventuring goals. |
help | [filter] | list CLI commands [that match filter]. |
item | switch to tab or open window | |
later | commands | adds a button to do commands to the Daily Deeds list. |
load | [numberx] filename | function [parameters] | check/run script. |
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. |
switch to tab or open window | ||
mood* | execute | repeat [numTimes] | moodName [numTimes] | mood management. |
objective* | add condition | set condition | modify your adventuring goals. |
opt* | switch to tab or open window | |
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 | equip | inv | storage | familiar | stickers | resynchronize with KoL. |
repeat | [number] | repeat previous line [number times]. |
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. |
trigger* | [type,] effect [, action] | edit current mood. Options for type are gain_effect, lose_effect, unconditional |
unalias | word | remove a CLI abbreviation. |
update | 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
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). |
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
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. |
attack | [ target [, target]... ] | PvP for dignity or flowers |
autoattack | skill | set default attack method. |
basement | check Fernswarthy's Basement status. | |
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. |
clan | [ snapshot | stashlog ] | clan management. |
csend | message ] | send kmail |
demons | list the demon names you know. | |
donate | 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. | |
familiar[?] | unlock | species | none | list or change familiar types |
field | harvest ] | view or use your mushroom plot |
flowers | commit random acts of PvP. | |
forum* | visit the official KoL forums. | |
friars | booze | get daily blessing. |
galaktik(hp|mp) | [amount] | restore some or all hp or mp |
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. | |
kmail | 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* | [item] list | goals ) [abort] | tag next monster [that drops all items in list, or your goals]. |
putty | [item] list | goals ) [abort] | tag next monster [that drops all items in list, or your goals]. |
pvp | [ target [, target]... ] | PvP for dignity or flowers |
pvplog* | summarize PvP results. | |
raffle | ticketsToBuy [ inventory | storage ] | buy raffle tickets |
recover* | mp | mana | both | attempt to regain some HP or MP. |
remedy[?] | effect [, effect]... | remove effects using appropriate means. |
restore* | mp | mana | both | attempt to regain some HP or MP. |
safe | location | show summary data for the specified area. |
send | message ] | send kmail |
shrug[?] | effect [, effect]... | remove effects using appropriate means. |
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 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. |
styx | 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. |
text | URL | show text results from visiting URL. |
train | 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. |