docs/cutechess-cli.txt

   1 CUTECHESS-CLI(6)
   2 ================
   3
   4 NAME
   5 ----
   6 cutechess-cli - A command-line tool for chess engines matches
   7
   8
   9 SYNOPSIS
  10 --------
  11 *cutechess-cli* -fcp ['ENGINE OPTIONS'] -scp ['ENGINE OPTIONS'] ['OPTIONS']
  12
  13 *cutechess-cli* -both ['ENGINE OPTIONS'] ['OPTIONS']
  14
  15 DESCRIPTION
  16 -----------
  17 Runs chess matches from the command line.
  18
  19
  20 OPTIONS
  21 -------
  22
  23 --version::
  24         Display the version information.
  25
  26 --help::
  27         Display help information.
  28
  29 --engines::
  30         Display the list of configured engines and exit.
  31
  32 -fcp <options>::
  33         Apply <options> to the first engine.
  34
  35 -scp <options>::
  36         Apply <options> to the second engine.
  37
  38 -both <options>::
  39         Apply <options> to both engines.
  40
  41 -variant <arg>::
  42         Set chess variant to <arg>. Must be 'Standard', 'Fischerandom',
  43         'Capablanca', 'Gothic' or 'Caprandom'.
  44
  45 -book <file>::
  46         Use <file> (Polyglot book file) as the opening book.
  47
  48 -bookdepth <n>::
  49         Set the maximum book depth (in plies) to <n>.
  50
  51 -draw <n> <score>::
  52         Adjudicate the game as a draw if the score of both engines is
  53         within <score> centipawns from zero after <n> full moves have
  54         been played.
  55
  56 -resign <n> <score>::
  57         Adjudicate the game as a loss if an engine's score is at least
  58         <score> centipawns below zero for at least <n> consecutive moves.
  59
  60 -event <arg>::
  61         Set the event name to <arg>.
  62
  63 -games <n>::
  64         Play <n> games.
  65
  66 -debug::
  67         Display all engine input and output.
  68
  69 -pgnin <file>::
  70         Use <file> as the opening book in PGN format.
  71
  72 -pgnout <file> [min]::
  73         Save the games to <file> in PGN format. Use the 'min' argument
  74         to save in a minimal PGN format.
  75
  76 -repeat::
  77         Play each opening twice so that both players get to play it on
  78         both sides.
  79
  80 -site <arg>::
  81         Set the site / location to <arg>.
  82
  83
  84 ENGINE OPTIONS
  85 --------------
  86
  87 conf=<arg>::
  88         Use an engine with the name <arg> from Cute Chess\' configuration
  89         file.
  90
  91 name=<arg>::
  92         Set the name to <arg>.
  93
  94 cmd=<arg>::
  95         Set the command to <arg>.
  96
  97 dir=<arg>::
  98         Set the working directory to <arg>.
  99
 100 arg=<arg>::
 101         Pass <arg> to the engine as a command line argument.
 102
 103 initstr=<arg>::
 104         Send <arg> to the engine's standard input at startup.
 105
 106 proto=<arg>::
 107         Set the chess protocol to <arg>. Must be 'xboard' or 'uci'.
 108
 109 tc=<arg>::
 110         Set the time control to <arg>. The format is
 111         moves/time+increment, where 'moves' is the number of
 112         moves per tc, 'time' is time per tc (either seconds or
 113         minutes:seconds), and 'increment' is time increment
 114         per move in seconds.
 115
 116 invertscores::
 117         Inverts the engine's scores when it plays black.
 118
 119 depth=<arg>::
 120         Set the search depth limit to <arg>.
 121
 122 nodes=<arg>::
 123         Set the node count limit to <arg>.
 124
 125 cpus=<n>::
 126         Tell the engine to use a maximum of <n> cpus.
 127
 128 egbbpath=<dir>::
 129         Set the path to endgame bitbases to <dir>.
 130
 131 egtbpath=<dir>::
 132         Set the path to endgame tablebases to <dir>.
 133
 134 uci.<name>=<arg>::
 135         Set UCI option <name> to value <arg>.
 136
 137
 138 EXAMPLES
 139 --------
 140
 141 * Play ten games between two Sloppy engines with a time
 142 control of 40 moves in 60 seconds.
 143
 144 -----------
 145 $ cutechess-cli -both cmd=sloppy tc=40/60 -games 10
 146 -----------
 147
 148 * Use the 'name=Atak' parameter because it's a Xboard
 149 protocol 1 engine and doesn't tell its name.
 150
 151 * Use the 'dir=C:\atak' parameter to point the location of
 152 the executable.
 153
 154 * Glaurung can tell its name and is in the PATH variable
 155 so only the command is needed.
 156
 157 * Set Glaurung to use 1 thread.
 158
 159 * Set the time control to 40 moves in one minute and 30
 160 seconds with a one second increment.
 161
 162 -----------
 163 $ cutechess-cli -fcp name=Atak cmd=Atak32.exe dir=C:\atak proto=xboard -scp cmd=glaurung proto=uci cpus=1 -both tc=40/1:30+1
 164 -----------
 165
 166 AUTHOR
 167 ------
 168 Written by Ilari Pihlajisto <ilari.pihlajisto@mbnet.fi> and Arto Jonsson
 169 <ajonsson@kapsi.fi>.
 170
 171
 172 RESOURCES
 173 ---------
 174 repo.or.cz: <http://repo.or.cz/w/sloppygui.git>
 175
 176
 177 COPYING
 178 -------
 179 Copyright \(C) 2008-2009 Ilari Pihlajisto and Arto Jonsson. Free use of this
 180 software is granted under the terms of GNU General Public License (GPL).
 181