CLI Reference: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
← Older edit
VisualWikitext
imported>HippoKing
m fixed another issue
imported>Fredg1
m →‎Mafia: typo
 
(89 intermediate revisions by 15 users not shown)
Line 1: Line 1:
The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.
The KoLmafia Graphical CLI is one of the most helpful features Mafia has. This page is intended to provide information on the commands available.


==Inventory Management==
=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 <span class="plainlinks">[http://en.wikipedia.org/wiki/Pilcrow pilcrow]</span>. 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"
{| class="wikitable" border="1"
|-
|-
Line 7: Line 45:
!  Arguments
!  Arguments
!  Description
!  Description
|-
|  *brewery*[?]
|  [ daily special &#124; item ]
|  show daily special [or consume it or other restaurant item].
|-
|  *kitchen*[?]
|  item
|  consumes item at Hell's Kitchen, if available.
|-
|  absorb
|  item
|  absorbs the item specified in a gelatinous noob run.
|-
|-
|  acquire
|  acquire
|  item
|  item  
|  Ensures you have argument item, making or buying when necessary.
|  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'' &#124; empty &#124; put ''item''... &#124; take ''item''...
|  list or manipulate your closet.
|-
|  create
|  [ item... ]
|  list creatables, or create specified items.
|-
|  display
|  ''filter'' &#124; put ''item''... &#124; take ''item''...
|  list or manipulate your display case.
|-
|  eat[?]
|  [either] item [, item]...
|  use/consume items
|-
|  edpiece[?]
|  [ bear &#124; owl &#124; puma &#124; hyena &#124; mouse &#124; weasel ]
|  place a golden animal on the Crown of Ed (and equip it if unequipped)
|-
|  equip
|  [list filter] &#124; [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.
|-
|  gap
|  [number&#124;text]
|  activates your Greatest American Pants, then performs "[[choice (CLI)|choice]] ''Argument''"
|-
|  ghost[?]
|  [either] item [, item]...
|  use/consume items
|-
|  hagnk
|  outfit name &#124; 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[?]
|  [+&#124;-&#124;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] &#124; save name &#124; checkpoint &#124; 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 &#124; 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 &#124; name
|  remove equipment in slot, or that matches name
|-
|  restaurant[?]
|  [ daily special &#124; 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.
|-
|  snowsuit[?]
|  ''decoration''
|  decorate Snowsuit (and equip it if unequipped)
|-
|  [[speculate]]
|  MCD num &#124; equip [slot] item &#124; unequip slot &#124; familiar type &#124; up eff &#124; uneffect eff &#124; quiet ; [another;...]
|  predict modifiers.
|-
|  squeeze[?]
|  item
|  produce item by using another form, repeated as needed.
|-
|  stash
|  [put] item... &#124; 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] &#124; [slot] item
|  show equipment, or equip item [in slot].
|-
|  [[whatif]]
|  MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
|  predict modifiers.
|-
|  wield
|  [list filter] &#124; [slot] item
|  show equipment, or equip item [in slot].
|-
|  zap
|  item [, item]...
|  transform items with your wand.
|}
|}


==Quests==
==Quests==
==Market Management==
==Mafia==
==Other==
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 27: Line 275:
|-
|-
|  !
|  !
|  
|
|  list the Dungeons of Doom potions you've identified.
|-
|  bang
| 
|  list the Dungeons of Doom potions you've identified.
|  list the Dungeons of Doom potions you've identified.
|-
|-
|  *.php*
|  baron
|  
| 
|  visit URL without showing results.
|  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.
|-
|-
|  *brewery*[?]
|  guardians
|   [ daily special | item ]
|
|  show daily special [or consume it or other restaurant item].
|  automatically complete quest.
|-
|-
|  *kitchen*[?]
|  guild
|   item
|
|  consumes item at Hell's Kitchen, if available.
|  automatically complete quest.
|-
|-
|  *mirror*
|  hedge*
|   [filename]
|
|  stop [or start] logging to an additional file.
|  automatically complete quest.
|-
|-
|  <inline-ash-script>
|  insults
|  
|
|  embed an ASH script in a CLI script.
|  list the pirate insult comebacks you know.
|-
|-
|  aa
|  leaflet
|   skill
| [nomagic] &#124; location &#124; command
|  set default attack method.
|  complete leaflet quest [without using magic words].
|-
|-
|  abort
|  maze
|   [message]
|
|  stop current script or automated task.
|  automatically complete quest.
|-
|-
|  acquire
|  nemesis
|   item
|
|  ensure that you have item, creating or buying it if needed.
|  automatically complete quest.
|-
|-
|  adv*[?]
|  poolskill
|   last | [count] location
|
|  spend your turns.
|  calculates your current pool skill
|-
|-
|  alias
|  spookyraven
|   [ word => expansion ]  
| [on &#124; off]
|  list or create CLI abbreviations.
|  when enabled, tracks Lights Out all the time
|-
|-
|  ash
|  tavern
|   statement
|
|  test a line of ASH code without having to edit a script.
|  automatically complete quest.
|-
|-
|  ashref
|  telescope
|   [filter]  
| [look] high &#124; low
|  summarize ASH built-in functions [matching filter].
|  get daily buff, or Lair hints from your telescope.
|-
|-
|  attack
|  tower
|   [ target [, target]... ]
|
| PvP for dignity or flowers
|  automatically complete quest.
|}
 
==Capitalism==
{| class="wikitable" border="1"
|-
|-
| autoattack
! Command Name
|  skill
!  Arguments
| set default attack method.
! Description
|-
|-
|  automall
|  automall
|  
|
|  dump all profitable, non-memento items into the Mall.
|  dump all profitable, non-memento items into the Mall.
|-
|-
|  autosell
|  autosell
|   item [, item]...  
| 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.
|  autosell items.
|-
|-
|  backtrace
|  shop
|   text | off
| put item [[@] price [[limit] num]] [, another] &#124; take [all] item [, another]
|  dump stack when a gCLI message or page URL matches text (case-sensitive).
|  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 &#124; [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.
|-
|-
|  bake
|  [[ashwiki]]
|   [ item... ]
| searchText
|  list creatables, or create specified items.
|  perform search on KoLmafia Wiki.
|-
|-
|  bang
|  ashref
|  
| [filter]
|  list the Dungeons of Doom potions you've identified.
|  summarize ASH built-in functions [matching filter].
|-
|-
|  basement
|  backtrace
|  
| text &#124; off
|  check Fernswarthy's Basement status.
|  dump stack when a gCLI message or page URL matches text (case-sensitive).
|-
|-
|  breakfast
|  breakfast
|  
|
|  perform start-of-day activities.
|  perform start-of-day activities.
|-
|-
|  budget
|  budget
|   [number]  
| [number]  
|  show [or set] the number of budgeted Hagnk's pulls.
|  show [or set] the number of budgeted Hagnk's pulls.
|-
|-
|  buffbot
|  buffbot
|   number  
| number  
|  run buffbot for number iterations.
|  run buffbot for number iterations.
|-
|-
|  -num
|  cache
| 
|  [clear]
|  use excess/all/specified/all but specified MP for buff extension and summons.
|  get image cache status or clear cache.
|-
|  buy
|  item [@ limit] [, another]...
|  buy from NPC store or the Mall.
|-
|-
|  call
|  call
|   [numberx] filename | function [parameters]  
| [numberx] filename &#124; function [parameters]  
|  check/run script.
|  check/run script.
|-
|  camp*
|  rest | etc. [numTimes]
|  perform campground actions.
|-
|  cast[?]
|  [ [count] skill [on player] ]
|  list spells, or use one.
|-
|-
|  ccs
|  ccs
|   [script]  
| [script]  
|  show [or select] Custom Combat Script in use.
|  show [or select] Custom Combat Script in use.
|-
|-
|  cecho
|  cecho
|   color text  
| color text  
|  show text using color (specified by name or #RRGGBB).
|  show text using color (specified by name or #RRGGBB).
|-
|  chamber
| 
|  automatically complete quest.
|-
|-
|  chat
|  chat
|  
|
|  switch to tab or open window
|  switch to tab or open window
|-
|  [,[-]item]...
|  [; cmds]
|  compare prices, do cmds with "it" replaced with best.
|-
|-
|  check
|  check
|   hp | health | mp | mana | both  
| hp &#124; health &#124; mp &#124; mana &#124; both  
|  attempt to regain some HP or MP.
|  attempt to regain some HP or MP.
|-
|-
|  checkpoint
|  checkpoint
|  
|
|  remembers current equipment, use "outfit checkpoint" to restore.
|  remembers current equipment, use "outfit checkpoint" to restore.
|-
|-
|  chew[?]
|  [[choice (CLI)|choice]]
|   [either] item [, item]...
| [number&#124;text]  
|  use/consume items
|  list or choose choice adventure options.
|-
|-
|  clan
|  [[choice (CLI)|choice-goal]]
|  [ snapshot | stashlog ]  
|   
|  clan management.
|  automatically complete quest.
|-
|  cleanup
| 
|  use, pulverize, or autosell your junk items.
|-
|-
|  clear
|  clear
|  
|
|  clear CLI window.
|  clear CLI window.
|-
|  closet
|  list filter | put item... | take item...
|  list or manipulate your closet.
|-
|-
|  cls
|  cls
|  
|
|  clear CLI window.
|  clear CLI window.
|-
|-
|  colorecho
|  [[condition]]*
|  color text
| clear &#124; check | add condition | set condition  
|  show text using color (specified by name or #RRGGBB).
|-
|  condition*
|   clear | check | add condition | set condition  
|  modify your adventuring goals.
|  modify your adventuring goals.
|-
|-
|  condref
|  condref
|  
|
|  list conditions usable with if/while commands.
|  list conditions usable with if/while commands.
|-
|-
|  council
|  [[counters]]
|  
| [ clear &#124; add number [title img] ]
|  visit the Council to advance quest progress.
|  show, clear, or add to current turn counters.
|-
|  debug
|  debug [on] &#124; off &#124; trace [ [on] &#124; off ] &#124; ash [ [on] &#124; off ] &#124; listener [ [on] &#124; off ]
|  start or stop logging of debugging data. ASH tracing goes into ASH_datestamp.txt
|-
|  disable
|  all &#124; command [, command]...
|  allow/deny CLI commands.
|-
|  events
|  [clear]
|  clear or show recent events.
|-
|  exec*
|  [numberx] filename &#124; 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 &#124; 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 &#124; function [parameters]
|  check/run script.
|-
|-
|  counters
|  location
|   [ clear | add number [title img] ]
| snarfblat loc
|  show, clear, or add to current turn counters.
|  Adds a new location named loc with the snarfblat number specified. This does not persist across session.
|-
|-
|  create
|  log
|   [ item... ]  
| [status],[equipment],[effects],[etc.]  
|  list creatables, or create specified items.
|  record data, "log snapshot" for all common data.
|-
|-
|  csend
|  logecho
|   item [, item]... to recipient [ | message ]
| timestamp &#124; text
|  send kmail
|  include timestamp or text in the session log only.
|-
|-
|  debug
|  login
|   [on] | off
| username
|  start or stop logging of debugging data.
|  logout then log back in as username.
|-
|-
|  demons
|  logout
|  
|
|  list the demon names you know.
|  logout and return to login window.
|-
|-
|  disable
|  logprint
|   all | command [, command]...
| timestamp &#124; text
|  allow/deny CLI commands.
|  include timestamp or text in the session log only.
|-
|-
|  display
|  mail
|   [filter] | put item... | take item...
|
|  list or manipulate your display case.
|  switch to tab or open window
|-
|-
|  donate
|  mood*
|   boris | mus | jarl | mys | pete | mox amount
| list &#124; listall &#124; clear &#124; autofill &#124; execute &#124; repeat [numTimes] &#124; moodName [numTimes]
|  donate in Hall of Legends.
|  mood management.
|-
|-
|  drink[?]
|  neweffect
|   [either] item [, item]...
| effect description ID
|  use/consume items
|  learn a new effect (add to database override)
|-
|-
|  dusty
|  [[objective]]*
|  
| clear &#124; check | add condition | set condition
|  list the dusty bottles of wine you've identified.
|  modify your adventuring goals.
|-
|-
|  eat[?]
|  opt*
|   [either] item [, item]...
|
|  use/consume items
|  switch to tab or open window
|-
|-
|  echo
|  print
|   timestamp | text  
| timestamp &#124; text  
|  include timestamp or text in the session log.
|  include timestamp or text in the session log.
|-
|-
|  effects
|  priphea
|   [param]  
| 
|  launch KoLmafia GUI.
|-
|  quit
| 
|  logout and exit KoLmafia.
|-
|  radio
| 
|  switch to tab or open window
|-
|  relay
| 
|  open the relay browser.
|-
|  refresh
|  all &#124; status &#124; equip &#124; inv &#124; shop &#124; storage &#124; familiar &#124; stickers
|  resynchronize with KoL.
|-
|  repeat
|  [number]
|  repeat previous line [number times].
|-
|  restores
|  [all &#124; obtainable]
|  List details of restores. (current, all or obtainable)
|-
|  run
|  [numberx] filename &#124; 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.
|  list indicated type of data, possibly filtered by param.
|-
|  set
|  preference [ = value ]
|  show/change preference settings
|-
|  start
|  [numberx] filename &#124; function [parameters]
|  check/run script.
|-
|  [[Svn#CLI_Commands|svn]]
|  checkout ''svnurl'' &#124; update [''svnurl''] &#124; list &#124; delete ''project'' &#124; sync
|  install/update/manage svn ''projects''.
|-
|  [[trigger]]*
|  clear &#124; autofill | [type,] effect [, action]
|  edit current mood. Options for type are gain_effect, lose_effect, unconditional
|-
|  unalias
|  word
|  remove a CLI abbreviation.
|-
|  update
|  data &#124; clear &#124; prices URL or filename
|  download most recent data files, or revert to built-in data.
|-
|  validate
|  [numberx] filename &#124; function [parameters]
|  check/run script.
|-
|  verify
|  [numberx] filename &#124; 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 &#124; text
|  include timestamp or text in the session log.
|-
|-
|  else
|  else
|   ; commands  
| ; commands  
|  do commands if preceding if/while/try didn't execute.
|  do commands if preceding if/while/try didn't execute.
|-
|-
|  elseif
|  elseif
|   condition; commands  
| condition; commands  
|  do if condition is true but preceding condition was false.
|  do if condition is true but preceding condition was false.
|-
|-
|  enable
|  if
|   all | command [, command]...
| condition; commands
|  allow/deny CLI commands.
|  do commands once if condition is true (see condref).
|-
|-
|  encounters
|  [[using|namespace]]
|   [param]  
| [filter]  
|  list indicated type of data, possibly filtered by param.
|  list namespace scripts and the functions they define.
|-
|-
|  entity
|  pause
|  
| [seconds]
|  give details of your current pastamancer combat entity.
|  pause script execution (default 1 second).
|-
|-
|  entryway
|  try
|   [clover]
| ; commands
|  automatically complete quest [using a clover].
|  do commands, and continue even if an error occurs.
|-
|-
|  equip
|  [[using]]
|  [list filter] | [slot] item
| filename
|  show equipment, or equip item [in slot].
|  add ASH script to namespace.
|-
|-
|  events
|  wait
|   [clear]  
| [seconds]  
|  clear or show recent events.
|  pause script execution (default 1 second).
|-
|-
|  exec*
|  while
|   [numberx] filename | function [parameters]
| condition; commands
|  check/run script.
|  do commands repeatedly while condition is true.
|}
 
==Other==
{| class="wikitable" border="1"
|-
|-
| exit
! Command Name
| 
!  Arguments
| logout and exit KoLmafia.
! Description
|-
|-
|  [,[-]item]...
|  *.php*
|   [; cmds]
|
|  compare prices, do cmds with "it" replaced with best.
|  visit URL without showing results.
|-
|-
|  factory
|  *mirror*
|   report digits
| [filename]
|  Given a string of 7 dwarven digits, report on factory.
|  stop [or start] logging to an additional file.
|-
|-
|  familiar[?]
|  aa
|   [list filter] | lock | unlock | species | none
| skill
|  list or change familiar types
|  set default attack method.
|-
|-
|  field
|  [[PvP Commands|attack]]
|   [ plant square type | pick square | harvest ]  
| attack target [, target...]
|  view or use your mushroom plot
|  PvP for items or fame
|-
|-
|  find
|  autoattack
|   item
| skill
|  ensure that you have item, creating or buying it if needed.
|  set default attack method.
|-
|-
|  flowers
|  ballpit
|  
|
|  commit random acts of PvP.
|  jump in your clan's awesome ball pit.
|-
|-
|  fold[?]
|  basement
|   item
|
|  produce item by using another form, repeated as needed.
|  check Fernswarthy's Basement status.
|-
|-
|  forum*
|  banishes
|  
|
|  visit the official KoL forums.
|  display information about current banishes.
|-
|-
|  friars
|  barrelprayer
|   [blessing] food | familiar | booze
| protection &#124; glamour &#124; vigor &#124; buff
|  get daily blessing.
|  make use of the Shrine to the Barrel god
|-
|-
|  galaktik(hp|mp)
|  boombox
|   [amount]
| giger &#124; spooky &#124; food &#124; alive &#124; dr &#124; fists &#124; damage &#124; meat &#124; silent &#124; off &#124; #
|  restore some or all hp or mp
|  get the indicated buff from the SongBoom BoomBox
|-
|-
|  gc
|  bounty
|  
| [ easy &#124; hard &#124; special]
|  force Java garbage collection.
|  List or optionally accept bounties of given difficulty
|-
|-
|  gear
|  [[enthrone (CLI)|bjornify]][?]
|  
| species
|  switch to tab or open window
|  place a familiar in the Buddy Bjorn.
|-
|-
|  get
|  burn
|   preference [ = value ]
| extra &#124; &#42; &#124; num &#124; -num
|  show/change preference settings
|  use excess/all/specified/all but specified MP for buff extension and summons.
|-
|-
|  ghost[?]
|  [[camp]]*
|   [either] item [, item]...
| rest &#124; etc. [numTimes]  
|  use/consume items
|  perform campground actions.
|-
|-
|  goal*
|  cast[?]
|   clear | check | add condition | set condition
| [ [count] skill [on player] ]
|  modify your adventuring goals.
|  list spells, or use one.
|-
|-
|  gourd
|  [http://kolmafia.us/showthread.php?18721-Deck-of-Every-Card&p=126239&viewfull=1#post126239 cheat]
|  
| ''cardname'' &#124; buff ''buffname'' &#124; phylum ''phylumname'' &#124; stat ''statname''
|  automatically complete quest.
|  cheat to draw cards from the {{kolwiki|Deck of Every Card}} (synonym of play)
|-
|-
|  grandpa
|  chips
|   query
| type [,type [,type]]
|  Ask Grandpa about something.
|  buy chips from your clan's snack machine: radium, ennui, wintergreen
|-
|-
|  guardians
|  clan
|  
| [ snapshot &#124; stashlog ]
|  automatically complete quest.
|  clan management.
|-
|-
|  guild
|  coinmaster
|  
| (buy &#124; sell) nickname item [,item] ...
|  automatically complete quest.
|  buy or sell items to specified coinmaster.
|-
|-
|  hagnk
|  crimbotree
|   outfit name | item [, item]...
| [ get ]  
|  pull items from Hagnk's storage.
|  check [or get present from] the Crimbo Tree in your clan's VIP lounge
|-
|-
|  hedge*
|  csend
|  
| item [, item]... to recipient [ &#124;&#124; message ]
|  automatically complete quest.
|  send kmail
|-
|-
|  help
|  dad
|   [filter]
|
|  list CLI commands [that match filter].
|  show the round-by-round elemental weaknesses of Dad Sea Monkee.
|-
|-
|  hermit[?]
|  demons
|   [item]
|
|  get clover status, or trade for item.
|  list the demon names you know.
|-
|-
|  hiddencity
|  donate
|   square [temple|altar item]
| boris &#124; mus &#124; jarl &#124; mys &#124; pete &#124; mox amount
|  set Hidden City square [and perform an action there].
|  donate in Hall of Legends.
|-
|-
|  hobo[?]
|  drink[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  holiday
|  effects
|   HolidayName
| [param]
|  enable special processing for unpredicted holidays.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  hottub
|  enable
|  
| all &#124; command [, command]...
|  soak in your clan's hot tub
|  allow/deny CLI commands.
|-
|-
|  http:*
|  encounters
|  
| [param]
|  visit URL without showing results.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  if
|  entity
|   condition; commands
|
|  do commands once if condition is true (see condref).
|  give details of your current pastamancer combat entity.
|-
|-
|  insults
|  [[enthrone (CLI)|enthrone]][?]
|  
| species
|  list the pirate insult comebacks you know.
|  place a familiar in the Crown of Thrones.
|-
|-
|  inv*
|  eudora
|   [param]
| penpal &#124; game lock &#124; xi
|  list indicated type of data, possibly filtered by param.
|  switch to the specified correspondent
|-
|-
|  item
|  familiar[?]
|  
| [list filter] &#124; lock &#124; unlock &#124; species &#124; none
|  switch to tab or open window
|  list or change familiar types
|-
|-
|  junk
|  fax
|  
| send &#124; put &#124; receive &#124; get
|  use, pulverize, or autosell your junk items.
|  use the fax machine in your clan's VIP lounge
|-
|-
|  kmail
|  faxbot
|   item [, item]... to recipient [ | message ]  
| [command]
|  send kmail
|  send the command cmd to faxbot
|-
|-
|  later
|  field
|   commands
| [ plant square type &#124; pick square &#124; harvest ]
|  adds a button to do commands to the Daily Deeds list.
|  view or use your mushroom plot
|-
|-
|  leaflet
|  florist
|   [nomagic] | location | command
| plant [plantname]
|  complete leaflet quest [without using magic words].
|  Add the plant to your current location
|-
|-
|  load
|  [[holiday]]
|   [numberx] filename | function [parameters]  
| [[PvP Commands|flowers]]
|  check/run script.
|  commit random acts of PvP.
|-
|-
|  locations
|  fortune
|   [param]  
| buff mus&#124;mys&#124;mox&#124;familiar&#124;meat&#124;item [''word1'' ''word2'' ''word3''] <br/> &#124; ''playername'' [''word1'' ''word2'' ''word3'']
|  list indicated type of data, possibly filtered by param.
|  Get fortune buff from Madame Zatara
|-
|-
|  log
|  forum*
|   [status],[equipment],[effects],[etc.]
|
|  record data, "log snapshot" for all common data.
|  visit the official KoL forums.
|-
|-
|  logecho
|  friars
|   timestamp | text
| [blessing] food &#124; familiar &#124; booze
|  include timestamp or text in the session log only.
|  get daily blessing.
|-
|-
|  login
|  genie
|   username
| effect ''effectname'' &#124; monster ''monstername'' &#124; stat (mus&#124;mys&#124;mox&#124;all) &#124; meat &#124; item&nbsp;(pony&#124;pocket&#124;shirt) &#124; wish ''wish'' &#124; freedom
|  logout then log back in as username.
|  make a wish with your Genie
|-
|-
|  logout
|  grim
|  
| init &#124; hpmp &#124; damage
|  logout and return to login window.
|  get a Grim Brother buff
|-
|-
|  logprint
|  HolidayName
|   timestamp | text
|
|  include timestamp or text in the session log only.
|  enable special processing for unpredicted holidays.
|-
|-
|  lookup
|  horsery
|   item | effect
| init &#124; -combat &#124; stat &#124; resist &#124; regen &#124; meat &#124; random &#124; spooky &#124; normal &#124; dark &#124; crazy &#124; pale &#124; #
|  go to appropriate KoL Wiki page.
|  get the indicated horse from the Horsery
|-
|-
|  mail
|  hottub
|  
|
|  switch to tab or open window
|  soak in your clan's hot tub
|-
|-
|  make
|  http:*
|   [ item... ]
|
|  list creatables, or create specified items.
|  visit URL without showing results.
|-
|-
|  mallbuy
|  ingredients
|   item [@ limit] [, another]...  
| item [, item]...
|  buy from NPC store or the Mall.
|  get ingredients or recipe for items
|-
|-
|  mallsell
|  kmail
|   item [[@] price [[limit] num]] [, another]...  
| item [, item]... to recipient [ &#124;&#124; message ]
|  sell in Mall.
|  send kmail
|-
|-
|  [+|-|weight]
|  locations
|   keyword, ...
|  [param]  
|  run the Modifier Maximizer.
| list indicated type of data, possibly filtered by param.
|-
|-
|  maze
|  lookup
|  
| [ effect &#124; familiar &#124; item &#124; skill &#124; outfit &#124; monster &#124; location ] ''target''
|  automatically complete quest.
|  go to appropriate KoL Wiki page for target.
|-
|-
|  mcd
|  mcd
|   number  
| number  
|  set mind control device (or equivalent) to new value.
|  set mind control device (or equivalent) to new value.
|-
|-
|  mind-control
|  mind-control
|   number  
| number  
|  set mind control device (or equivalent) to new value.
|  set mind control device (or equivalent) to new value.
|-
|  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.
|-
|-
|  moleref
|  moleref
|  
|
|  Path of the Mole spoilers.
|  Path of the Mole spoilers.
|-
|-
|  monsters
|  monsters
|   location  
| location  
|  show combat details for the specified area.
|  show combat details for the specified area.
|-
|  mood*
|  clear | autofill | execute | repeat [numTimes] | moodName [numTimes]
|  mood management.
|-
|-
|  moon*
|  moon*
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  mpitems
|  mpitems
|  
|
|  counts MP restoratives in inventory.
|  counts MP restoratives in inventory.
|-
|-
|  namespace
|  mummery
|  [filter]
|  muscle &#124; myst &#124; moxie &#124; hp &#124; mp &#124; item &#124; meat &#124; #
|  list namespace scripts and the functions they define.
|  dress familiar with costume from Mumming Trunk
|-
|  nemesis
| 
|  automatically complete quest.
|-
|-
|  nuns
|  nuns
|   [mp]  
| [mp]  
|  visit the Nunnery for restoration [but only if MP is restored].
|  visit the Nunnery for restoration [but only if MP is restored].
|-
|  objective*
|  clear | check | add condition | set condition
|  modify your adventuring goals.
|-
|-
|  olfact*
|  olfact*
|   ( none | monster name | [item] list | goals ) [abort]  
| ( none &#124; monster name &#124; [item] list &#124; goals ) [abort]  
|  tag next monster [that drops all items in list, or your goals].
|  tag next monster [that drops all items in list, or your goals].
|-
|-
|  opt*
|  [[panda]]
|  
| moan | temple | comedy type | arena bandmember item
|  switch to tab or open window
|  interact with NPCs in Pandamonium
|-
|-
|  outfit
|  [http://kolmafia.us/showthread.php?18721-Deck-of-Every-Card&p=126239&viewfull=1#post126239 play]
|  [list filter] | save name | checkpoint | name
| ''cardname'' &#124; buff ''buffname'' &#124; phylum ''phylumname'' &#124; stat ''statname''
|  list, save, restore, or change outfits.
|  cheat to draw cards from the {{kolwiki|Deck of Every Card}} (synonym of cheat)
|-
|-
|  overdrink[?]
|  pool
|   [either] item [, item]...
| type [,type [,type]]
|  use/consume items
|  play pool games in your clan's VIP lounge
|-
|  pause
|  [seconds]  
|  pause script execution (default 1 second).
|-
|  ply
|  [ item... ]
|  list creatables, or create specified items.
|-
|  print
|  timestamp | text
|  include timestamp or text in the session log.
|-
|  priphea
| 
|  launch KoLmafia GUI.
|-
|  pull
|  outfit name | item [, item]...
|  pull items from Hagnk's storage.
|-
|  pulverize
|  item [, item]...
|  pulverize specified items
|-
|-
|  putty
|  putty
|   ( none | monster name | [item] list | goals ) [abort]  
| ( none &#124; monster name &#124; [item] list &#124; goals ) [abort]  
|  tag next monster [that drops all items in list, or your goals].
|  tag next monster [that drops all items in list, or your goals].
|-
|-
|  pvp
|  [[PvP Commands|pvp]]
|   [ target [, target]... ]  
| [attacks] ( flowers &#124; loot &#124; fame ) [muscle&#124;myst&#124;moxie&#124;ballyhoo]
|  PvP for dignity or flowers
|  commit random acts of PvP [using the specified stance].
|-
|-
|  pvplog*
|  pvplog*
|  
|
|  summarize PvP results.
|  summarize PvP results.
|-
|  quark[?]
|  [itemList...]
|  gain MP by pasting unstable quark with best item from itemList (or your junk list).
|-
|  quit
| 
|  logout and exit KoLmafia.
|-
|  radio
| 
|  switch to tab or open window
|-
|-
|  raffle
|  raffle
|   ticketsToBuy [ inventory | storage ]  
| ticketsToBuy [ inventory &#124; storage ]  
|  buy raffle tickets
|  buy raffle tickets
|-
|  recipe
|  item [, item]...
|  get ingredients or recipe for items.
|-
|-
|  recover*
|  recover*
|   hp | health | mp | mana | both  
| hp &#124; health &#124; mp &#124; mana &#124; both  
|  attempt to regain some HP or MP.
|  attempt to regain some HP or MP.
|-
|  refresh
|  all | status | equip | inv | storage | familiar | stickers
|  resynchronize with KoL.
|-
|  relay
| 
|  open the relay browser.
|-
|-
|  remedy[?]
|  remedy[?]
|   effect [, effect]...  
| effect [, effect]...  
|  remove effects using appropriate means.
|  remove effects using appropriate means.
|-
|  remove
|  slot | name
|  remove equipment in slot, or that matches name
|-
|  repeat
|  [number]
|  repeat previous line [number times].
|-
|  reprice
| 
|  price all max-priced items at or below current Mall minimum price.
|-
|  restaurant[?]
|  [ daily special | item ]
|  show daily special [or consume it or other restaurant item].
|-
|-
|  restore*
|  restore*
|   hp | health | mp | mana | both  
| hp &#124; health &#124; mp &#124; mana &#124; both  
|  attempt to regain some HP or MP.
|  attempt to regain some HP or MP.
|-
|  retrieve
|  item
|  ensure that you have item, creating or buying it if needed.
|-
|  run
|  [numberx] filename | function [parameters]
|  check/run script.
|-
|-
|  safe
|  safe
|   location  
| location  
|  show summary data for the specified area.
|  show summary data for the specified area.
|-
|  save
|  as mood
|  add your current effects to the mood.
|-
|  searchmall
|  item [ with limit number ]
|  search the Mall.
|-
|  sell
|  item [, item]...
|  autosell items.
|-
|-
|  send
|  send
|   item [, item]... to recipient [ | message ]  
| item [, item]... to recipient [ &#124;&#124; message ]  
|  send kmail
|  send kmail
|-
|-
|  session
|  shower
|  [param]
|  cold &#124; ice &#124; cool &#124; moxie &#124; lukewarm &#124; mysticality &#124; warm &#124; muscle &#124; hot &#124; mp
|  list indicated type of data, possibly filtered by param.
|  take a shower in your clan's VIP lounge
|-
|  set
|  preference [ = value ]
|  show/change preference settings
|-
|-
|  shrug[?]
|  shrug[?]
|   effect [, effect]...  
| effect [, effect]...  
|  remove effects using appropriate means.
|  remove effects using appropriate means.
|-
|  skeleton
|  warrior &#124; cleric &#124; wizard &#124; rogue &#124; buddy
|  Use a single skeleton and select from the choice adventure according to the parameter
|-
|-
|  skill[?]
|  skill[?]
|   [ [count] skill [on player] ]  
| [ [count] skill [on player] ]  
|  list spells, or use one.
|  list spells, or use one.
|-
|-
|  skills
|  skills
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  sleep
|  sleep
|   number  
| number  
|  rest on your clan sofa for number turns.
|  rest on your clan sofa for number turns.
|-
|  slimeling[?]
|  [either] item [, item]...
|  use/consume items
|-
|  smash
|  item [, item]...
|  pulverize specified items
|-
|  smith
|  [ item... ]
|  list creatables, or create specified items.
|-
|-
|  soak
|  soak
|  
|
|  soak in your clan's hot tub
|  soak in your clan's VIP hot tub
|-
|-
|  sofa
|  sofa
|   number  
| number  
|  rest on your clan sofa for number turns.
|  rest on your clan sofa for number turns.
|-
|-
|  spade
|  spade
|   [prices URL]  
| [prices URL]  
|  submit automatically gathered data.
|  submit automatically gathered data.
|-
|  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.
|-
|  start
|  [numberx] filename | function [parameters]
|  check/run script.
|-
|  stash
|  [put] item... | take item...
|  exchange items with clan stash
|-
|-
|  status
|  status
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  sticker*
|  [[PvP Commands|steal]]
|  sticker1 [, sticker2 [, sticker3]]  
|  [attacks] ( flowers &#124; loot &#124; fame ) [muscle&#124;myst&#124;moxie&#124;ballyhoo]
|  replace worn stickers.
|  commit random acts of PvP [using the specified stance].
|-
|  storage
|  [param]  
|  list indicated type of data, possibly filtered by param.
|-
|-
|  styx
|  styx
|   muscle | mysticality | moxie  
| muscle &#124; mysticality &#124; moxie  
|  get daily Styx Pixie buff.
|  get daily Styx Pixie buff.
|-
|-
|  summary
|  summary
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  summon
|  summon
|   demonName | effect | location | number  
| demonName &#124; effect &#124; location &#124; number  
|  use the Summoning Chamber.
|  use the Summoning Chamber.
|-
|-
|  tavern
|  [[PvP Commands|swagger]]
|  
|
|  automatically complete quest.
|  commit random acts of PvP.
|-
|  swim
|  laps &#124; ml &#124; sprints &#124; noncombat
|  work out in your clan's VIP lounge swimming pool
|-
|-
|  telescope
|  teatree
|   [look] high | low
| shake &#124; [tea name]
|  get daily buff, or Lair hints from your telescope.
|  Harvest random or specific tea
|-
|-
|  text
|  text
|   URL  
| URL  
|  show text results from visiting URL.
|  show text results from visiting URL.
|-
|  tinker
|  [ item... ]
|  list creatables, or create specified items.
|-
|  tower
| 
|  automatically complete quest.
|-
|-
|  train
|  train
|   base weight | buffed weight | turns number  
| base weight &#124; buffed weight &#124; turns number  
|  train familiar.
|  train familiar.
|-
|  trigger*
|  clear | autofill | [type,] effect [, action]
|  edit current mood
|-
|  try
|  ; commands
|  do commands, and continue even if an error occurs.
|-
|  unalias
|  word
|  remove a CLI abbreviation.
|-
|  undercut
| 
|  price all max-priced items at or below current Mall minimum price.
|-
|-
|  uneffect[?]
|  uneffect[?]
|   effect [, effect]...  
| effect [, effect]...  
|  remove effects using appropriate means.
|  remove effects using appropriate means.
|-
|-
|  unequip
|  unequip
|   slot | name  
| slot &#124; name  
|  remove equipment in slot, or that matches name
|  remove equipment in slot, or that matches name
|-
|  untinker
|  [ item... ]
|  complete quest, or untinker items.
|-
|-
|  up?
|  up?
|   effect [, effect]...  
| effect [, effect]...  
|  extend duration of effects.
|  extend duration of effects.
|-
|-
|  update
|  wiki
|   data | clear | prices URL or filename
| searchText
|  download most recent data files, or revert to built-in data.
|  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
|-
|-
|  use[?]
|  checkconsumption
|   [either] item [, item]...
| rXXXX
|  use/consume items
|  description goes here
|-
|-
|  using
|  checkeffects
|   filename
| r6966
|  add ASH script to namespace.
|  Check KoLmafia's effect data for correctness.
|-
|-
|  validate
|  checkfamiliars
|   [numberx] filename | function [parameters]
| rXXXX
|  check/run script.
|  description goes here
|-
|-
|  verify
|  checkitems
|   [numberx] filename | function [parameters]
| r6966
|  check/run script.
|  description goes here
|-
|-
|  version
|  checkmodifiers
|  
| r4640
|  display KoLmafia version.
|  Check KoLmafia's modifier data for correctness.
|-
|-
|  wait
|  checkoutfits
|   [seconds]
| r14949
|  pause script execution (default 1 second).
|  description goes here
|-
|-
|  wear
|  checkplurals
|   [list filter] | [slot] item
| rXXXX
|  show equipment, or equip item [in slot].
|  description goes here
|-
|-
|  whatif
|  checkpotions
|   MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| r9791
|  predict modifiers.
|  description goes here
|-
|-
|  while
|  checkpowers
|   condition; commands
| r9080
|  do commands repeatedly while condition is true.
|  Check KoLmafia's equipment power data for correctness. Note: This is only done for equipment you possess.
|-
|-
|  wield
|  checkprofile
|   [list filter] | [slot] item
| r6539
|  show equipment, or equip item [in slot].
|  description goes here
|-
|-
|  wiki
|  checkpulverization
|   searchText
| rXXXX
|  perform search on KoL Wiki.
|  description goes here
|-
|-
|  win
|  checkshields
|   game
| r9091
|  I'm as surprised as you! I didn't think it was possible.
|  Check KoLmafia's equipment data pertaining to shields for correctness.
|-
|-
|  zap
|  checkzapgroups
|   item [, item]...
| rXXXX
|  transform items with your wand.
|  description goes here
|}
|}
[[Category:CLI Commands]]

Latest revision as of 20:56, 12 August 2019

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 autosell 5 heavy D, you can use one of the following to indicate a variable quantity:

  • * is used to indicate all items in inventory.
autosell * heavy D
  • 0 is also used to indicate all items in inventory.
autosell 0 heavy D
  • a negative number means sell off all items except for the number listed. For example, -5 means keep 5 and sell the rest.
autosell -5 heavy D

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 1 WA as a 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 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".
send 1 ¶4358 to Bale|Thanks for being awesome
is a way to send A Crimbo Carol, Ch. 5 to Bale despite the comma in the item's name.

Commands

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.
absorb item absorbs the item specified in a gelatinous noob run.
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 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
edpiece[?] [ bear | owl | puma | hyena | mouse | weasel ] place a golden animal on the Crown of Ed (and equip it if unequipped)
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.
gap [number|text] activates your Greatest American Pants, then performs "choice Argument"
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.
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.
snowsuit[?] decoration decorate Snowsuit (and equip it if unequipped)
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.
baron finds the baron in the Tavern.
bugbears List progress of 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

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

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.
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 [number|text] list or choose choice adventure options.
choice-goal automatically complete quest.
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 debug [on] | off | trace [ [on] | off ] | ash [ [on] | off ] | listener [ [on] | off ] start or stop logging of debugging data. ASH tracing goes into ASH_datestamp.txt
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* 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* 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 | shop | 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 checkout svnurl | update [svnurl] | list | delete project | sync install/update/manage svn projects.
trigger* [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

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 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.
barrelprayer protection | glamour | vigor | buff make use of the Shrine to the Barrel god
boombox giger | spooky | food | alive | dr | fists | damage | meat | silent | off | # get the indicated buff from the SongBoom BoomBox
bounty [ easy | hard | special] List or optionally accept bounties of given difficulty
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.
cheat cardname | buff buffname | phylum phylumname | stat statname cheat to draw cards from the Deck of Every Card (synonym of play)
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[?] 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 flowers commit random acts of PvP.
fortune buff mus|mys|mox|familiar|meat|item [word1 word2 word3]
| playername [word1 word2 word3] 		Get fortune buff from Madame Zatara
forum* visit the official KoL forums.
friars [blessing] food | familiar | booze get daily blessing.
genie effect effectname | monster monstername | stat (mus|mys|mox|all) | meat | item (pony|pocket|shirt) | wish wish | freedom make a wish with your Genie
grim init | hpmp | damage get a Grim Brother buff
HolidayName enable special processing for unpredicted holidays.
horsery init | -combat | stat | resist | regen | meat | random | spooky | normal | dark | crazy | pale | # get the indicated horse from the Horsery
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 [ effect | familiar | item | skill | outfit | monster | location ] target go to appropriate KoL Wiki page for target.
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.
mummery muscle | myst | moxie | hp | mp | item | meat | # dress familiar with costume from Mumming Trunk
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 temple | comedy type | arena bandmember item interact with NPCs in Pandamonium
play cardname | buff buffname | phylum phylumname | stat statname cheat to draw cards from the Deck of Every Card (synonym of cheat)
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 [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.
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.
swagger commit random acts of PvP.
swim laps | ml | sprints | noncombat work out in your clan's VIP lounge swimming pool
teatree shake | [tea name] Harvest random or specific tea
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.

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
Retrieved from "https://wiki.kolmafia.us/index.php?title=CLI_Reference&oldid=3005"