xo Family CLIs

xo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
usage: xo [-h] [-v] [--auth-user AUTH_USER] [--auth-password AUTH_PASSWORD]
          {create,init,reset,list,show,take} ...

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         enable more verbose output
  --auth-user AUTH_USER
                        username for authentication if REST API is using Basic
                        Auth
  --auth-password AUTH_PASSWORD
                        password for authentication if REST API is using Basic
                        Auth

subcommands:
  {create,init,reset,list,show,take}

xo create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
usage: xo create [-h] [-v] [--auth-user AUTH_USER]
                 [--auth-password AUTH_PASSWORD] [--disable-client-validation]
                 [--wait [WAIT]]
                 name

positional arguments:
  name                  an identifier for the new game

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         enable more verbose output
  --auth-user AUTH_USER
                        username for authentication if REST API is using Basic
                        Auth
  --auth-password AUTH_PASSWORD
                        password for authentication if REST API is using Basic
                        Auth
  --disable-client-validation
                        disable client validation
  --wait [WAIT]         wait for game to commit, set an integer to specify a
                        timeout

xo init

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
usage: xo init [-h] [-v] [--auth-user AUTH_USER]
               [--auth-password AUTH_PASSWORD] [--username USERNAME]
               [--url URL]

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         enable more verbose output
  --auth-user AUTH_USER
                        username for authentication if REST API is using Basic
                        Auth
  --auth-password AUTH_PASSWORD
                        password for authentication if REST API is using Basic
                        Auth
  --username USERNAME   the name of the player
  --url URL             the url of the REST API

xo list

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
usage: xo list [-h] [-v] [--auth-user AUTH_USER]
               [--auth-password AUTH_PASSWORD]

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         enable more verbose output
  --auth-user AUTH_USER
                        username for authentication if REST API is using Basic
                        Auth
  --auth-password AUTH_PASSWORD
                        password for authentication if REST API is using Basic
                        Auth

xo reset

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
usage: xo reset [-h] [-v] [--auth-user AUTH_USER]
                [--auth-password AUTH_PASSWORD]

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         enable more verbose output
  --auth-user AUTH_USER
                        username for authentication if REST API is using Basic
                        Auth
  --auth-password AUTH_PASSWORD
                        password for authentication if REST API is using Basic
                        Auth

xo show

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
usage: xo show [-h] [-v] [--auth-user AUTH_USER]
               [--auth-password AUTH_PASSWORD]
               name

positional arguments:
  name                  the identifier for the game

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         enable more verbose output
  --auth-user AUTH_USER
                        username for authentication if REST API is using Basic
                        Auth
  --auth-password AUTH_PASSWORD
                        password for authentication if REST API is using Basic
                        Auth

xo take

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
usage: xo take [-h] [-v] [--auth-user AUTH_USER]
               [--auth-password AUTH_PASSWORD]
               name space

positional arguments:
  name                  the identifier for the game
  space                 the square number to take

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         enable more verbose output
  --auth-user AUTH_USER
                        username for authentication if REST API is using Basic
                        Auth
  --auth-password AUTH_PASSWORD
                        password for authentication if REST API is using Basic
                        Auth

xo-tp-python

1
2
3
4
5
6
7
8
usage: xo-tp-python [-h] [-v] [endpoint]

positional arguments:
  endpoint       Endpoint for the validator connection

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  Increase output sent to stderr