CLI Reference: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
imported>HippoKing
m fixed another issue
imported>HippoKing
m wikies are horrible but I think I finally got the table syntax right
Line 27: Line 27:
|-
|-
|  !
|  !
|  
|
|  list the Dungeons of Doom potions you've identified.
|  list the Dungeons of Doom potions you've identified.
|-
|-
|  *.php*
|  *.php*
|  
|
|  visit URL without showing results.
|  visit URL without showing results.
|-
|-
|  *brewery*[?]
|  *brewery*[?]
|   [ daily special | item ]  
| [ daily special | item ]  
|  show daily special [or consume it or other restaurant item].
|  show daily special [or consume it or other restaurant item].
|-
|-
|  *kitchen*[?]
|  *kitchen*[?]
|   item  
| item  
|  consumes item at Hell's Kitchen, if available.
|  consumes item at Hell's Kitchen, if available.
|-
|-
|  *mirror*
|  *mirror*
|   [filename]  
| [filename]  
|  stop [or start] logging to an additional file.
|  stop [or start] logging to an additional file.
|-
|-
|  <inline-ash-script>
|  <inline-ash-script>
|  
|
|  embed an ASH script in a CLI script.
|  embed an ASH script in a CLI script.
|-
|-
|  aa
|  aa
|   skill  
| skill  
|  set default attack method.
|  set default attack method.
|-
|-
|  abort
|  abort
|   [message]  
| [message]  
|  stop current script or automated task.
|  stop current script or automated task.
|-
|-
|  acquire
|  acquire
|   item  
| item  
|  ensure that you have item, creating or buying it if needed.
|  ensure that you have item, creating or buying it if needed.
|-
|-
|  adv*[?]
|  adv*[?]
|   last | [count] location  
| last &#124; [count] location  
|  spend your turns.
|  spend your turns.
|-
|-
|  alias
|  alias
|   [ word => expansion ]  
| [ word => expansion ]  
|  list or create CLI abbreviations.
|  list or create CLI abbreviations.
|-
|-
|  ash
|  ash
|   statement  
| statement  
|  test a line of ASH code without having to edit a script.
|  test a line of ASH code without having to edit a script.
|-
|-
|  ashref
|  ashref
|   [filter]  
| [filter]  
|  summarize ASH built-in functions [matching filter].
|  summarize ASH built-in functions [matching filter].
|-
|-
|  attack
|  attack
|   [ target [, target]... ]  
| [ target [, target]... ]  
|  PvP for dignity or flowers
|  PvP for dignity or flowers
|-
|-
|  autoattack
|  autoattack
|   skill  
| skill  
|  set default attack method.
|  set default attack method.
|-
|-
|  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.
|  autosell items.
|-
|-
|  backtrace
|  backtrace
|   text | off  
| text &#124; off  
|  dump stack when a gCLI message or page URL matches text (case-sensitive).
|  dump stack when a gCLI message or page URL matches text (case-sensitive).
|-
|-
|  bake
|  bake
|   [ item... ]  
| [ item... ]  
|  list creatables, or create specified items.
|  list creatables, or create specified items.
|-
|-
|  bang
|  bang
|  
|
|  list the Dungeons of Doom potions you've identified.
|  list the Dungeons of Doom potions you've identified.
|-
|-
|  basement
|  basement
|  
|
|  check Fernswarthy's Basement status.
|  check Fernswarthy's Basement status.
|-
|-
|  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
|  -num
|  
|
|  use excess/all/specified/all but specified MP for buff extension and summons.
|  use excess/all/specified/all but specified MP for buff extension and summons.
|-
|-
|  buy
|  buy
|   item [@ limit] [, another]...  
| item [@ limit] [, another]...  
|  buy from NPC store or the Mall.
|  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*
|  camp*
|   rest | etc. [numTimes]  
| rest &#124; etc. [numTimes]  
|  perform campground actions.
|  perform campground actions.
|-
|-
|  cast[?]
|  cast[?]
|   [ [count] skill [on player] ]  
| [ [count] skill [on player] ]  
|  list spells, or use one.
|  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
|  chamber
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  chat
|  chat
|  
|
|  switch to tab or open window
|  switch to tab or open window
|-
|-
|  [,[-]item]...
|  [,[-]item]...
|   [; cmds]  
| [; cmds]  
|  compare prices, do cmds with "it" replaced with best.
|  compare prices, do cmds with "it" replaced with best.
|-
|-
|  check
|  check
|   hp | health | mp | mana | both  
| hp &#124; health | mp | mana | 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[?]
|  chew[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  clan
|  clan
|   [ snapshot | stashlog ]  
| [ snapshot &#124; stashlog ]  
|  clan management.
|  clan management.
|-
|-
|  cleanup
|  cleanup
|  
|
|  use, pulverize, or autosell your junk items.
|  use, pulverize, or autosell your junk items.
|-
|-
|  clear
|  clear
|  
|
|  clear CLI window.
|  clear CLI window.
|-
|-
|  closet
|  closet
|   list filter | put item... | take item...  
| list filter &#124; put item... | take item...  
|  list or manipulate your closet.
|  list or manipulate your closet.
|-
|-
|  cls
|  cls
|  
|
|  clear CLI window.
|  clear CLI window.
|-
|-
|  colorecho
|  colorecho
|   color text  
| color text  
|  show text using color (specified by name or #RRGGBB).
|  show text using color (specified by name or #RRGGBB).
|-
|-
|  condition*
|  condition*
|   clear | check | add condition | set condition  
| clear &#124; 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
|  council
|  
|
|  visit the Council to advance quest progress.
|  visit the Council to advance quest progress.
|-
|-
|  counters
|  counters
|   [ clear | add number [title img] ]  
| [ clear &#124; add number [title img] ]  
|  show, clear, or add to current turn counters.
|  show, clear, or add to current turn counters.
|-
|-
|  create
|  create
|   [ item... ]  
| [ item... ]  
|  list creatables, or create specified items.
|  list creatables, or create specified items.
|-
|-
|  csend
|  csend
|   item [, item]... to recipient [ | message ]  
| item [, item]... to recipient [ &#124;| message ]  
|  send kmail
|  send kmail
|-
|-
|  debug
|  debug
|   [on] | off  
| [on] &#124; off  
|  start or stop logging of debugging data.
|  start or stop logging of debugging data.
|-
|-
|  demons
|  demons
|  
|
|  list the demon names you know.
|  list the demon names you know.
|-
|-
|  disable
|  disable
|   all | command [, command]...  
| all &#124; command [, command]...  
|  allow/deny CLI commands.
|  allow/deny CLI commands.
|-
|-
|  display
|  display
|   [filter] | put item... | take item...  
| [filter] &#124; put item... | take item...  
|  list or manipulate your display case.
|  list or manipulate your display case.
|-
|-
|  donate
|  donate
|   boris | mus | jarl | mys | pete | mox amount  
| boris &#124; mus | jarl | mys | pete | mox amount  
|  donate in Hall of Legends.
|  donate in Hall of Legends.
|-
|-
|  drink[?]
|  drink[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  dusty
|  dusty
|  
|
|  list the dusty bottles of wine you've identified.
|  list the dusty bottles of wine you've identified.
|-
|-
|  eat[?]
|  eat[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  echo
|  echo
|   timestamp | text  
| timestamp &#124; text  
|  include timestamp or text in the session log.
|  include timestamp or text in the session log.
|-
|-
|  effects
|  effects
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  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
|  enable
|   all | command [, command]...  
| all &#124; command [, command]...  
|  allow/deny CLI commands.
|  allow/deny CLI commands.
|-
|-
|  encounters
|  encounters
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  entity
|  entity
|  
|
|  give details of your current pastamancer combat entity.
|  give details of your current pastamancer combat entity.
|-
|-
|  entryway
|  entryway
|   [clover]  
| [clover]  
|  automatically complete quest [using a clover].
|  automatically complete quest [using a clover].
|-
|-
|  equip
|  equip
|   [list filter] | [slot] item  
| [list filter] &#124; [slot] item  
|  show equipment, or equip item [in slot].
|  show equipment, or equip item [in slot].
|-
|-
|  events
|  events
|   [clear]  
| [clear]  
|  clear or show recent events.
|  clear or show recent events.
|-
|-
|  exec*
|  exec*
|   [numberx] filename | function [parameters]  
| [numberx] filename &#124; function [parameters]  
|  check/run script.
|  check/run script.
|-
|-
|  exit
|  exit
|  
|
|  logout and exit KoLmafia.
|  logout and exit KoLmafia.
|-
|-
|  [,[-]item]...
|  [,[-]item]...
|   [; cmds]  
| [; cmds]  
|  compare prices, do cmds with "it" replaced with best.
|  compare prices, do cmds with "it" replaced with best.
|-
|-
|  factory
|  factory
|   report digits  
| report digits  
|  Given a string of 7 dwarven digits, report on factory.
|  Given a string of 7 dwarven digits, report on factory.
|-
|-
|  familiar[?]
|  familiar[?]
|   [list filter] | lock | unlock | species | none  
| [list filter] &#124; lock | unlock | species | none  
|  list or change familiar types
|  list or change familiar types
|-
|-
|  field
|  field
|   [ plant square type | pick square | harvest ]  
| [ plant square type &#124; pick square | harvest ]  
|  view or use your mushroom plot
|  view or use your mushroom plot
|-
|-
|  find
|  find
|   item  
| item  
|  ensure that you have item, creating or buying it if needed.
|  ensure that you have item, creating or buying it if needed.
|-
|-
|  flowers
|  flowers
|  
|
|  commit random acts of PvP.
|  commit random acts of PvP.
|-
|-
|  fold[?]
|  fold[?]
|   item  
| item  
|  produce item by using another form, repeated as needed.
|  produce item by using another form, repeated as needed.
|-
|-
|  forum*
|  forum*
|  
|
|  visit the official KoL forums.
|  visit the official KoL forums.
|-
|-
|  friars
|  friars
|   [blessing] food | familiar | booze  
| [blessing] food &#124; familiar | booze  
|  get daily blessing.
|  get daily blessing.
|-
|-
|  galaktik(hp|mp)
|  galaktik(hp&#124;mp)
|   [amount]  
| [amount]  
|  restore some or all hp or mp
|  restore some or all hp or mp
|-
|-
|  gc
|  gc
|  
|
|  force Java garbage collection.
|  force Java garbage collection.
|-
|-
|  gear
|  gear
|  
|
|  switch to tab or open window
|  switch to tab or open window
|-
|-
|  get
|  get
|   preference [ = value ]  
| preference [ = value ]  
|  show/change preference settings
|  show/change preference settings
|-
|-
|  ghost[?]
|  ghost[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  goal*
|  goal*
|   clear | check | add condition | set condition  
| clear &#124; check | add condition | set condition  
|  modify your adventuring goals.
|  modify your adventuring goals.
|-
|-
|  gourd
|  gourd
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  grandpa
|  grandpa
|   query  
| query  
|  Ask Grandpa about something.
|  Ask Grandpa about something.
|-
|-
|  guardians
|  guardians
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  guild
|  guild
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  hagnk
|  hagnk
|   outfit name | item [, item]...  
| outfit name &#124; item [, item]...  
|  pull items from Hagnk's storage.
|  pull items from Hagnk's storage.
|-
|-
|  hedge*
|  hedge*
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  help
|  help
|   [filter]  
| [filter]  
|  list CLI commands [that match filter].
|  list CLI commands [that match filter].
|-
|-
|  hermit[?]
|  hermit[?]
|   [item]  
| [item]  
|  get clover status, or trade for item.
|  get clover status, or trade for item.
|-
|-
|  hiddencity
|  hiddencity
|   square [temple|altar item]  
| square [temple&#124;altar item]  
|  set Hidden City square [and perform an action there].
|  set Hidden City square [and perform an action there].
|-
|-
|  hobo[?]
|  hobo[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  holiday
|  holiday
|   HolidayName  
| HolidayName  
|  enable special processing for unpredicted holidays.
|  enable special processing for unpredicted holidays.
|-
|-
|  hottub
|  hottub
|  
|
|  soak in your clan's hot tub
|  soak in your clan's hot tub
|-
|-
|  http:*
|  http:*
|  
|
|  visit URL without showing results.
|  visit URL without showing results.
|-
|-
|  if
|  if
|   condition; commands  
| condition; commands  
|  do commands once if condition is true (see condref).
|  do commands once if condition is true (see condref).
|-
|-
|  insults
|  insults
|  
|
|  list the pirate insult comebacks you know.
|  list the pirate insult comebacks you know.
|-
|-
|  inv*
|  inv*
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  item
|  item
|  
|
|  switch to tab or open window
|  switch to tab or open window
|-
|-
|  junk
|  junk
|  
|
|  use, pulverize, or autosell your junk items.
|  use, pulverize, or autosell your junk items.
|-
|-
|  kmail
|  kmail
|   item [, item]... to recipient [ | message ]  
| item [, item]... to recipient [ &#124;| message ]  
|  send kmail
|  send kmail
|-
|-
|  later
|  later
|   commands  
| commands  
|  adds a button to do commands to the Daily Deeds list.
|  adds a button to do commands to the Daily Deeds list.
|-
|-
|  leaflet
|  leaflet
|   [nomagic] | location | command  
| [nomagic] &#124; location | command  
|  complete leaflet quest [without using magic words].
|  complete leaflet quest [without using magic words].
|-
|-
|  load
|  load
|   [numberx] filename | function [parameters]  
| [numberx] filename &#124; function [parameters]  
|  check/run script.
|  check/run script.
|-
|-
|  locations
|  locations
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  log
|  log
|   [status],[equipment],[effects],[etc.]  
| [status],[equipment],[effects],[etc.]  
|  record data, "log snapshot" for all common data.
|  record data, "log snapshot" for all common data.
|-
|-
|  logecho
|  logecho
|   timestamp | text  
| timestamp &#124; text  
|  include timestamp or text in the session log only.
|  include timestamp or text in the session log only.
|-
|-
|  login
|  login
|   username  
| username  
|  logout then log back in as username.
|  logout then log back in as username.
|-
|-
|  logout
|  logout
|  
|
|  logout and return to login window.
|  logout and return to login window.
|-
|-
|  logprint
|  logprint
|   timestamp | text  
| timestamp &#124; text  
|  include timestamp or text in the session log only.
|  include timestamp or text in the session log only.
|-
|-
|  lookup
|  lookup
|   item | effect  
| item &#124; effect  
|  go to appropriate KoL Wiki page.
|  go to appropriate KoL Wiki page.
|-
|-
|  mail
|  mail
|  
|
|  switch to tab or open window
|  switch to tab or open window
|-
|-
|  make
|  make
|   [ item... ]  
| [ item... ]  
|  list creatables, or create specified items.
|  list creatables, or create specified items.
|-
|-
|  mallbuy
|  mallbuy
|   item [@ limit] [, another]...  
| item [@ limit] [, another]...  
|  buy from NPC store or the Mall.
|  buy from NPC store or the Mall.
|-
|-
|  mallsell
|  mallsell
|   item [[@] price [[limit] num]] [, another]...  
| item [[@] price [[limit] num]] [, another]...  
|  sell in Mall.
|  sell in Mall.
|-
|-
|  [+|-|weight]
|  [+&#124;-|weight]
|   keyword, ...  
| keyword, ...  
|  run the Modifier Maximizer.
|  run the Modifier Maximizer.
|-
|-
|  maze
|  maze
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  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
|  mix
|   [ item... ]  
| [ item... ]  
|  list creatables, or create specified items.
|  list creatables, or create specified items.
|-
|-
|  modifies
|  modifies
|   filter  
| filter  
|  list all possible sources of modifiers matching filter.
|  list all possible sources of modifiers matching filter.
|-
|-
|  modref
|  modref
|   [object]  
| [object]  
|  list all modifiers, show values for player [and object].
|  list all modifiers, show values for player [and object].
|-
|-
|  modtrace
|  modtrace
|   filter  
| filter  
|  list everything that adds to modifiers matching 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*
|  mood*
|   clear | autofill | execute | repeat [numTimes] | moodName [numTimes]  
| clear &#124; autofill | execute | repeat [numTimes] | moodName [numTimes]  
|  mood management.
|  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
|  namespace
|   [filter]  
| [filter]  
|  list namespace scripts and the functions they define.
|  list namespace scripts and the functions they define.
|-
|-
|  nemesis
|  nemesis
|  
|
|  automatically complete quest.
|  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*
|  objective*
|   clear | check | add condition | set condition  
| clear &#124; check | add condition | set condition  
|  modify your adventuring goals.
|  modify your adventuring goals.
|-
|-
|  olfact*
|  olfact*
|   ( none | monster name | [item] list | goals ) [abort]  
| ( none &#124; monster name | [item] list | 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*
|  opt*
|  
|
|  switch to tab or open window
|  switch to tab or open window
|-
|-
|  outfit
|  outfit
|   [list filter] | save name | checkpoint | name  
| [list filter] &#124; save name | checkpoint | name  
|  list, save, restore, or change outfits.
|  list, save, restore, or change outfits.
|-
|-
|  overdrink[?]
|  overdrink[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  pause
|  pause
|   [seconds]  
| [seconds]  
|  pause script execution (default 1 second).
|  pause script execution (default 1 second).
|-
|-
|  ply
|  ply
|   [ item... ]  
| [ item... ]  
|  list creatables, or create specified items.
|  list creatables, or create specified items.
|-
|-
|  print
|  print
|   timestamp | text  
| timestamp &#124; text  
|  include timestamp or text in the session log.
|  include timestamp or text in the session log.
|-
|-
|  priphea
|  priphea
|  
|
|  launch KoLmafia GUI.
|  launch KoLmafia GUI.
|-
|-
|  pull
|  pull
|   outfit name | item [, item]...  
| outfit name &#124; item [, item]...  
|  pull items from Hagnk's storage.
|  pull items from Hagnk's storage.
|-
|-
|  pulverize
|  pulverize
|   item [, item]...  
| item [, item]...  
|  pulverize specified items
|  pulverize specified items
|-
|-
|  putty
|  putty
|   ( none | monster name | [item] list | goals ) [abort]  
| ( none &#124; monster name | [item] list | 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
|   [ target [, target]... ]  
| [ target [, target]... ]  
|  PvP for dignity or flowers
|  PvP for dignity or flowers
|-
|-
|  pvplog*
|  pvplog*
|  
|
|  summarize PvP results.
|  summarize PvP results.
|-
|-
|  quark[?]
|  quark[?]
|   [itemList...]  
| [itemList...]  
|  gain MP by pasting unstable quark with best item from itemList (or your junk list).
|  gain MP by pasting unstable quark with best item from itemList (or your junk list).
|-
|-
|  quit
|  quit
|  
|
|  logout and exit KoLmafia.
|  logout and exit KoLmafia.
|-
|-
|  radio
|  radio
|  
|
|  switch to tab or open window
|  switch to tab or open window
|-
|-
|  raffle
|  raffle
|   ticketsToBuy [ inventory | storage ]  
| ticketsToBuy [ inventory &#124; storage ]  
|  buy raffle tickets
|  buy raffle tickets
|-
|-
|  recover*
|  recover*
|   hp | health | mp | mana | both  
| hp &#124; health | mp | mana | both  
|  attempt to regain some HP or MP.
|  attempt to regain some HP or MP.
|-
|-
|  refresh
|  refresh
|   all | status | equip | inv | storage | familiar | stickers  
| all &#124; status | equip | inv | storage | familiar | stickers  
|  resynchronize with KoL.
|  resynchronize with KoL.
|-
|-
|  relay
|  relay
|  
|
|  open the relay browser.
|  open the relay browser.
|-
|-
|  remedy[?]
|  remedy[?]
|   effect [, effect]...  
| effect [, effect]...  
|  remove effects using appropriate means.
|  remove effects using appropriate means.
|-
|-
|  remove
|  remove
|   slot | name  
| slot &#124; name  
|  remove equipment in slot, or that matches name
|  remove equipment in slot, or that matches name
|-
|-
|  repeat
|  repeat
|   [number]  
| [number]  
|  repeat previous line [number times].
|  repeat previous line [number times].
|-
|-
|  reprice
|  reprice
|  
|
|  price all max-priced items at or below current Mall minimum price.
|  price all max-priced items at or below current Mall minimum price.
|-
|-
|  restaurant[?]
|  restaurant[?]
|   [ daily special | item ]  
| [ daily special &#124; item ]  
|  show daily special [or consume it or other restaurant item].
|  show daily special [or consume it or other restaurant item].
|-
|-
|  restore*
|  restore*
|   hp | health | mp | mana | both  
| hp &#124; health | mp | mana | both  
|  attempt to regain some HP or MP.
|  attempt to regain some HP or MP.
|-
|-
|  retrieve
|  retrieve
|   item  
| item  
|  ensure that you have item, creating or buying it if needed.
|  ensure that you have item, creating or buying it if needed.
|-
|-
|  run
|  run
|   [numberx] filename | function [parameters]  
| [numberx] filename &#124; function [parameters]  
|  check/run script.
|  check/run script.
|-
|-
|  safe
|  safe
|   location  
| location  
|  show summary data for the specified area.
|  show summary data for the specified area.
|-
|-
|  save
|  save
|   as mood  
| as mood  
|  add your current effects to the mood.
|  add your current effects to the mood.
|-
|-
|  searchmall
|  searchmall
|   item [ with limit number ]  
| item [ with limit number ]  
|  search the Mall.
|  search the Mall.
|-
|-
|  sell
|  sell
|   item [, item]...  
| item [, item]...  
|  autosell items.
|  autosell items.
|-
|-
|  send
|  send
|   item [, item]... to recipient [ | message ]  
| item [, item]... to recipient [ &#124;| message ]  
|  send kmail
|  send kmail
|-
|-
|  session
|  session
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  set
|  set
|   preference [ = value ]  
| preference [ = value ]  
|  show/change preference settings
|  show/change preference settings
|-
|-
|  shrug[?]
|  shrug[?]
|   effect [, effect]...  
| effect [, effect]...  
|  remove effects using appropriate means.
|  remove effects using appropriate means.
|-
|-
|  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[?]
|  slimeling[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  smash
|  smash
|   item [, item]...  
| item [, item]...  
|  pulverize specified items
|  pulverize specified items
|-
|-
|  smith
|  smith
|   [ item... ]  
| [ item... ]  
|  list creatables, or create specified items.
|  list creatables, or create specified items.
|-
|-
|  soak
|  soak
|  
|
|  soak in your clan's hot tub
|  soak in your clan's 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
|  speculate
|   MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]  
| MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]  
|  predict modifiers.
|  predict modifiers.
|-
|-
|  squeeze[?]
|  squeeze[?]
|   item  
| item  
|  produce item by using another form, repeated as needed.
|  produce item by using another form, repeated as needed.
|-
|-
|  start
|  start
|   [numberx] filename | function [parameters]  
| [numberx] filename &#124; function [parameters]  
|  check/run script.
|  check/run script.
|-
|-
|  stash
|  stash
|   [put] item... | take item...  
| [put] item... &#124; take item...  
|  exchange items with clan stash
|  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*
|  sticker*
|   sticker1 [, sticker2 [, sticker3]]  
| sticker1 [, sticker2 [, sticker3]]  
|  replace worn stickers.
|  replace worn stickers.
|-
|-
|  storage
|  storage
|   [param]  
| [param]  
|  list indicated type of data, possibly filtered by param.
|  list indicated type of data, possibly filtered by param.
|-
|-
|  styx
|  styx
|   muscle | mysticality | moxie  
| muscle &#124; mysticality | 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 | location | number  
|  use the Summoning Chamber.
|  use the Summoning Chamber.
|-
|-
|  tavern
|  tavern
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  telescope
|  telescope
|   [look] high | low  
| [look] high &#124; low  
|  get daily buff, or Lair hints from your telescope.
|  get daily buff, or Lair hints from your telescope.
|-
|-
|  text
|  text
|   URL  
| URL  
|  show text results from visiting URL.
|  show text results from visiting URL.
|-
|-
|  tinker
|  tinker
|   [ item... ]  
| [ item... ]  
|  list creatables, or create specified items.
|  list creatables, or create specified items.
|-
|-
|  tower
|  tower
|  
|
|  automatically complete quest.
|  automatically complete quest.
|-
|-
|  train
|  train
|   base weight | buffed weight | turns number  
| base weight &#124; buffed weight | turns number  
|  train familiar.
|  train familiar.
|-
|-
|  trigger*
|  trigger*
|   clear | autofill | [type,] effect [, action]  
| clear &#124; autofill | [type,] effect [, action]  
|  edit current mood
|  edit current mood
|-
|-
|  try
|  try
|   ; commands  
| ; commands  
|  do commands, and continue even if an error occurs.
|  do commands, and continue even if an error occurs.
|-
|-
|  unalias
|  unalias
|   word  
| word  
|  remove a CLI abbreviation.
|  remove a CLI abbreviation.
|-
|-
|  undercut
|  undercut
|  
|
|  price all max-priced items at or below current Mall minimum price.
|  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
|  untinker
|   [ item... ]  
| [ item... ]  
|  complete quest, or untinker items.
|  complete quest, or untinker items.
|-
|-
|  up?
|  up?
|   effect [, effect]...  
| effect [, effect]...  
|  extend duration of effects.
|  extend duration of effects.
|-
|-
|  update
|  update
|   data | clear | prices URL or filename  
| data &#124; clear | prices URL or filename  
|  download most recent data files, or revert to built-in data.
|  download most recent data files, or revert to built-in data.
|-
|-
|  use[?]
|  use[?]
|   [either] item [, item]...  
| [either] item [, item]...  
|  use/consume items
|  use/consume items
|-
|-
|  using
|  using
|   filename  
| filename  
|  add ASH script to namespace.
|  add ASH script to namespace.
|-
|-
|  validate
|  validate
|   [numberx] filename | function [parameters]  
| [numberx] filename &#124; function [parameters]  
|  check/run script.
|  check/run script.
|-
|-
|  verify
|  verify
|   [numberx] filename | function [parameters]  
| [numberx] filename &#124; function [parameters]  
|  check/run script.
|  check/run script.
|-
|-
|  version
|  version
|  
|
|  display KoLmafia version.
|  display KoLmafia version.
|-
|-
|  wait
|  wait
|   [seconds]  
| [seconds]  
|  pause script execution (default 1 second).
|  pause script execution (default 1 second).
|-
|-
|  wear
|  wear
|   [list filter] | [slot] item  
| [list filter] &#124; [slot] item  
|  show equipment, or equip item [in slot].
|  show equipment, or equip item [in slot].
|-
|-
|  whatif
|  whatif
|   MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]  
| MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]  
|  predict modifiers.
|  predict modifiers.
|-
|-
|  while
|  while
|   condition; commands  
| condition; commands  
|  do commands repeatedly while condition is true.
|  do commands repeatedly while condition is true.
|-
|-
|  wield
|  wield
|   [list filter] | [slot] item  
| [list filter] &#124; [slot] item  
|  show equipment, or equip item [in slot].
|  show equipment, or equip item [in slot].
|-
|-
|  wiki
|  wiki
|   searchText  
| searchText  
|  perform search on KoL Wiki.
|  perform search on KoL Wiki.
|-
|-
|  win
|  win
|   game  
| game  
|  I'm as surprised as you! I didn't think it was possible.
|  I'm as surprised as you! I didn't think it was possible.
|-
|-
|  zap
|  zap
|   item [, item]...  
| item [, item]...  
|  transform items with your wand.
|  transform items with your wand.
|}
|}

Revision as of 15:31, 30 August 2009

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

Inventory Management

Command Arguments Description
acquire item Ensures you have argument item, making or buying when necessary.

Quests

Market Management

Mafia

Other

Command Name Arguments Description
! list the Dungeons of Doom potions you've identified.
*.php* visit URL without showing results.
*brewery*[?] [ daily special | item ] show daily special [or consume it or other restaurant item].
*kitchen*[?] item consumes item at Hell's Kitchen, if available.
*mirror* [filename] stop [or start] logging to an additional file.
<inline-ash-script> embed an ASH script in a CLI script.
aa skill set default attack method.
abort [message] stop current script or automated task.
acquire item ensure that you have item, creating or buying it if needed.
adv*[?] last | [count] location spend your turns.
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].
attack [ target [, target]... ] PvP for dignity or flowers
autoattack skill set default attack method.
automall dump all profitable, non-memento items into the Mall.
autosell item [, item]... autosell items.
backtrace text | off dump stack when a gCLI message or page URL matches text (case-sensitive).
bake [ item... ] list creatables, or create specified items.
bang list the Dungeons of Doom potions you've identified.
basement check Fernswarthy's Basement status.
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.
-num use excess/all/specified/all but specified MP for buff extension and summons.
buy item [@ limit] [, another]... buy from NPC store or the Mall.
call [numberx] filename | function [parameters] check/run script.
camp* rest | etc. [numTimes] perform campground actions.
cast[?] [ [count] skill [on player] ] list spells, or use one.
ccs [script] show [or select] Custom Combat Script in use.
cecho color text show text using color (specified by name or #RRGGBB).
chamber automatically complete quest.
chat switch to tab or open window
[,[-]item]... [; cmds] compare prices, do cmds with "it" replaced with best.
check mp | mana | both attempt to regain some HP or MP.
checkpoint remembers current equipment, use "outfit checkpoint" to restore.
chew[?] [either] item [, item]... use/consume items
clan [ snapshot | stashlog ] clan management.
cleanup use, pulverize, or autosell your junk items.
clear clear CLI window.
closet take item... list or manipulate your closet.
cls clear CLI window.
colorecho color text show text using color (specified by name or #RRGGBB).
condition* add condition | set condition modify your adventuring goals.
condref list conditions usable with if/while commands.
council visit the Council to advance quest progress.
counters [ clear | add number [title img] ] show, clear, or add to current turn counters.
create [ item... ] list creatables, or create specified items.
csend message ] send kmail
debug [on] | off start or stop logging of debugging data.
demons list the demon names you know.
disable all | command [, command]... allow/deny CLI commands.
display take item... list or manipulate your display case.
donate jarl | mys | pete | mox amount donate in Hall of Legends.
drink[?] [either] item [, item]... use/consume items
dusty list the dusty bottles of wine you've identified.
eat[?] [either] item [, item]... use/consume items
echo timestamp | text include timestamp or text in the session log.
effects [param] list indicated type of data, possibly filtered by param.
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.
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.
entryway [clover] automatically complete quest [using a clover].
equip [list filter] | [slot] item show equipment, or equip item [in slot].
events [clear] clear or show recent events.
exec* [numberx] filename | function [parameters] check/run script.
exit logout and exit KoLmafia.
[,[-]item]... [; cmds] compare prices, do cmds with "it" replaced with best.
factory report digits Given a string of 7 dwarven digits, report on factory.
familiar[?] unlock | species | none list or change familiar types
field harvest ] view or use your mushroom plot
find item ensure that you have item, creating or buying it if needed.
flowers commit random acts of PvP.
fold[?] item produce item by using another form, repeated as needed.
forum* visit the official KoL forums.
friars booze get daily blessing.
galaktik(hp|mp) [amount] restore some or all hp or mp
gc force Java garbage collection.
gear switch to tab or open window
get preference [ = value ] show/change preference settings
ghost[?] [either] item [, item]... use/consume items
goal* add condition | set condition modify your adventuring goals.
gourd automatically complete quest.
grandpa query Ask Grandpa about something.
guardians automatically complete quest.
guild automatically complete quest.
hagnk outfit name | item [, item]... pull items from Hagnk's storage.
hedge* automatically complete quest.
help [filter] list CLI commands [that match filter].
hermit[?] [item] get clover status, or trade for item.
hiddencity square [temple|altar item] set Hidden City square [and perform an action there].
hobo[?] [either] item [, item]... use/consume items
holiday HolidayName enable special processing for unpredicted holidays.
hottub soak in your clan's hot tub
http:* visit URL without showing results.
if condition; commands do commands once if condition is true (see condref).
insults list the pirate insult comebacks you know.
inv* [param] list indicated type of data, possibly filtered by param.
item switch to tab or open window
junk use, pulverize, or autosell your junk items.
kmail message ] send kmail
later commands adds a button to do commands to the Daily Deeds list.
leaflet command complete leaflet quest [without using magic words].
load [numberx] filename | function [parameters] check/run script.
locations [param] list indicated type of data, possibly filtered by param.
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.
lookup item | effect go to appropriate KoL Wiki page.
mail switch to tab or open window
make [ item... ] list creatables, or create specified items.
mallbuy item [@ limit] [, another]... buy from NPC store or the Mall.
mallsell item [[@] price [[limit] num]] [, another]... sell in Mall.
weight] keyword, ... run the Modifier Maximizer.
maze automatically complete quest.
mcd number set mind control device (or equivalent) to new value.
mind-control number 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 Path of the Mole spoilers.
monsters location show combat details for the specified area.
mood* execute | repeat [numTimes] | moodName [numTimes] mood management.
moon* [param] list indicated type of data, possibly filtered by param.
mpitems counts MP restoratives in inventory.
namespace [filter] list namespace scripts and the functions they define.
nemesis automatically complete quest.
nuns [mp] visit the Nunnery for restoration [but only if MP is restored].
objective* add condition | set condition modify your adventuring goals.
olfact* [item] list | goals ) [abort] tag next monster [that drops all items in list, or your goals].
opt* switch to tab or open window
outfit checkpoint | name list, save, restore, or change outfits.
overdrink[?] [either] item [, item]... use/consume items
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 [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.
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 ticketsToBuy [ inventory | storage ] buy raffle tickets
recover* mp | mana | both attempt to regain some HP or MP.
refresh equip | inv | storage | familiar | stickers resynchronize with KoL.
relay open the relay browser.
remedy[?] effect [, effect]... 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* mp | mana | both 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 location 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 message ] send kmail
session [param] list indicated type of data, possibly filtered by param.
set preference [ = value ] show/change preference settings
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.
slimeling[?] [either] item [, item]... use/consume items
smash item [, item]... pulverize specified items
smith [ item... ] list creatables, or create specified items.
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.
speculate 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 [param] list indicated type of data, possibly filtered by param.
sticker* sticker1 [, sticker2 [, sticker3]] replace worn stickers.
storage [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 location | number use the Summoning Chamber.
tavern automatically complete quest.
telescope [look] high | low get daily buff, or Lair hints from your telescope.
text URL show text results from visiting URL.
tinker [ item... ] list creatables, or create specified items.
tower automatically complete quest.
train turns number train familiar.
trigger* [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[?] effect [, effect]... remove effects using appropriate means.
unequip slot | name remove equipment in slot, or that matches name
untinker [ item... ] complete quest, or untinker items.
up? effect [, effect]... extend duration of effects.
update prices URL or filename download most recent data files, or revert to built-in data.
use[?] [either] item [, item]... use/consume items
using filename add ASH script to namespace.
validate [numberx] filename | function [parameters] check/run script.
verify [numberx] filename | function [parameters] check/run script.
version display KoLmafia version.
wait [seconds] pause script execution (default 1 second).
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.
while condition; commands do commands repeatedly while condition is true.
wield [list filter] | [slot] item show equipment, or equip item [in slot].
wiki searchText perform search on KoL Wiki.
win game I'm as surprised as you! I didn't think it was possible.
zap item [, item]... transform items with your wand.
Retrieved from "https://wiki.kolmafia.us/index.php?title=CLI_Reference&oldid=2916"