Command line · 07

Connect cloud KataGo to GUIs and scripts with Read19 CLI

Sign in once with the native CLI, then choose GTP or Analysis Engine JSONL. Sabaki, LizzieYzy, q5Go, and KaTrain never manage a local model or GPU.

  1. Install the native CLI and sign in

    Download the native build for your operating system and chip from /cli, verify its SHA-256, and keep read19 in a fixed place such as ~/.local/bin/read19 on macOS or C:\Tools\read19.exe on Windows. The macOS build is not notarized yet, so a browser download first needs xattr -d com.apple.quarantine read19. Then run read19 login (--no-open without a browser) and read19 engine setup --name "MacBook · Sabaki" to create and store a key for this client.

    Login authorizes the account; engine setup creates a separately revocable credential for this client.
  2. Select engine gtp in a GUI

    A GUI launched from the desktop does not read your terminal PATH, so always enter an absolute path. Sabaki: Engines → Manage Engines… → Add, set the path to the absolute read19 path and the arguments to engine gtp, attach it from the engines sidebar, and press F4 to toggle analysis. LizzieYzy: Engines → Engine Management, and enter “/absolute/path/read19 engine gtp” as the whole command; this needs CLI 0.2.14 or later. q5Go takes the same path and engine gtp arguments. KaTrain does not use GTP: enter “/absolute/path/read19 engine analysis” in the local engine's Override Engine Command, or use the WebSocket URL from the account page.

    The GUI sees a local GTP process. The CLI translates positions into cloud requests and returns GTP responses.
  3. Select engine analysis for scripts

    For complete machine-readable JSON, run read19 engine analysis, write one Analysis Engine query per line to stdin, and read results line by line from stdout; after stdin closes, the CLI waits for the final result of every submitted query. Use read19 usage, statement, and status to inspect usage, ledger entries, and service health. Continuous GUI analysis searches until you stop it, so turn it off when you are not reading the board.

    The JSONL path bypasses a GUI and fits shell pipelines, Python, Node.js, and batch research tools.

Full command reference

  1. Read19 CLI downloads and commands
  2. KataGo GTP extensions

Signs of success

  • read19 account can load the account
  • The GUI shows the engine name KataGo Read19
  • Candidates keep updating and stop growing after you stop
  • Usage shows the matching job
Read models and metrics