Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Client CLI reference

Generated from oppx 0.8.1 (f3d1893).

Use an OpenPhalanx GPU server from this machine.

Run `oppx` in a git repo to start the OpenPhalanx chat (keys and commands follow Claude Code), or pair first with `oppx pair <server> <code>`.

Examples:
  oppx
  oppx "fix the failing test"
  oppx -p "explain src/main.rs"
  oppx -c   (continue the last conversation)
  oppx -r   (pick a past conversation)
  oppx --update

Usage: oppx [OPTIONS] [PROMPT]
       oppx <COMMAND>

Commands:
  pair     Pair with a server using the code shown in the OpenPhalanx app, or with the server on this machine: `oppx pair self` (no code needed)
  status   Check the connection, the device token and the model
  unpair   Forget a server and revoke this device's token on it
  aider    Run Aider with its own terminal interface (plain `oppx` uses OpenPhalanx's)
  proxy    Run only the local proxy, for other OpenAI-compatible tools
  search   Search the web through the server's private SearXNG
  mcp      Connectors: MCP servers whose tools the model can call in the chat.
  browser  The chat's headless web browser (Playwright), run on this machine.
  servers  List paired servers (tokens are never shown)
  use      Set the default server
  help     Print this message or the help of the given subcommand(s)

Arguments:
  [PROMPT]
          Start the chat with this request

Options:
      --config <CONFIG>
          Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json)
          
          [env: OPPX_CONFIG=]

      --no-web
          With no command: start without automatic web search

      --classic
          With no command: use Aider's own terminal interface instead of OpenPhalanx's

      --engine <ENGINE>
          How the chat works: "agent" (the model reads files on demand with tools) or "aider" (Aider sends whole files and a repo map every time)
          
          [env: OPPX_ENGINE=]
          [default: agent]
          [possible values: agent, aider]

  -p, --print
          Print mode: answer PROMPT once and exit (for scripts and quick questions)

  -c, --continue
          Continue the most recent conversation in this repo

  -r, --resume [<ID>]
          Resume a past conversation in this repo (pick from a list, or give its id)

      --update
          Update oppx and its coding engine to the latest version

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

oppx pair

Pair with a server using the code shown in the OpenPhalanx app, or with the server on this machine: `oppx pair self` (no code needed)

Usage: oppx pair [OPTIONS] <SERVER> [CODE]

Arguments:
  <SERVER>  Server address, e.g. 192.168.1.77 or https://gpu.lan:9090; or `self`
  [CODE]    Pairing code from the app's Server page, e.g. K7QF-M2XD (not for `self`)

Options:
      --config <CONFIG>            Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json) [env: OPPX_CONFIG=]
      --fingerprint <FINGERPRINT>  Expected certificate fingerprint (as shown in the app); skips the prompt
  -y, --yes                        Accept the server's certificate without comparing fingerprints
      --device-name <NAME>         Name this device shows under on the app's Client page
      --as <NAME>                  Local name for the server (defaults to its address)
      --force                      Replace an existing pairing with the same local name
  -h, --help                       Print help

oppx status

Check the connection, the device token and the model

Usage: oppx status [OPTIONS] [NAME]

Arguments:
  [NAME]  Server name (defaults to the default server)

Options:
      --config <CONFIG>  Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json) [env: OPPX_CONFIG=]
  -h, --help             Print help

oppx unpair

Forget a server and revoke this device's token on it

Usage: oppx unpair [OPTIONS] [NAME]

Arguments:
  [NAME]  Server name (defaults to the default server)

Options:
      --config <CONFIG>  Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json) [env: OPPX_CONFIG=]
      --local-only       Only forget it locally; don't contact the server
  -h, --help             Print help

oppx aider

Run Aider with its own terminal interface (plain `oppx` uses OpenPhalanx's).

Everything after `--` (or any unrecognized argument) goes to Aider, e.g. `oppx aider -- --message "add tests" src/lib.rs`.

Usage: oppx aider [OPTIONS] [AIDER_ARGS]...

Arguments:
  [AIDER_ARGS]...
          Arguments passed through to Aider

Options:
      --config <CONFIG>
          Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json)
          
          [env: OPPX_CONFIG=]

      --server <SERVER>
          Server name (defaults to the default server)

      --no-web
          Don't let the server search the web automatically

  -h, --help
          Print help (see a summary with '-h')

oppx proxy

Run only the local proxy, for other OpenAI-compatible tools

Usage: oppx proxy [OPTIONS] [NAME]

Arguments:
  [NAME]  Server name (defaults to the default server)

Options:
      --config <CONFIG>  Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json) [env: OPPX_CONFIG=]
      --port <PORT>      Local port (default: a free one) [default: 0]
      --no-web           Don't let the server search the web automatically
  -h, --help             Print help

Search the web through the server's private SearXNG.

Inside Aider: `/run oppx search "your query"` adds the results to the chat.

Usage: oppx search [OPTIONS] <QUERY>...

Arguments:
  <QUERY>...
          What to search for

Options:
      --config <CONFIG>
          Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json)
          
          [env: OPPX_CONFIG=]

  -n, --max <MAX>
          Number of results
          
          [default: 6]

      --server <SERVER>
          Server name (defaults to the default server)

  -h, --help
          Print help (see a summary with '-h')

oppx mcp

Connectors: MCP servers whose tools the model can call in the chat.

A connector is a program on this machine or a URL that offers tools
(GitHub, a database, a browser…). The chat lists them for the model,
and asks you before each call. In the chat, `/mcp` does the same.

Examples:
  oppx mcp add github -e GITHUB_TOKEN=… -- npx -y @modelcontextprotocol/server-github
  oppx mcp add docs --url https://mcp.example.com/mcp -H "Authorization: Bearer …"
  oppx mcp list
  oppx mcp remove github

Each connector's tool list is sent with every request, so on a model
with a small context window add only the ones you need.

Usage: oppx mcp [OPTIONS] [COMMAND]

Commands:
  add     Add a connector: a command to run (after `--`), or a URL.
  remove  Remove a connector (yours, or this repository's with --project)
  list    Show the connectors you added and this repository's (the default)
  help    Print this message or the help of the given subcommand(s)

Options:
      --config <CONFIG>
          Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json)
          
          [env: OPPX_CONFIG=]

  -h, --help
          Print help (see a summary with '-h')

oppx browser

The chat's headless web browser (Playwright), run on this machine.

The model uses it to open pages (your local dev server included),
click, type, and read the page and its console errors. By default the
chat asks once a session before starting it; `on` starts it with every
session without asking. Needs Node.js 18 or newer.

  oppx browser            show the setting and what is installed
  oppx browser on | off   start it with every session, or ask first (the default)
  oppx browser install    install it now (otherwise on first use)

Usage: oppx browser [OPTIONS] [COMMAND]

Commands:
  on       Start the browser with every chat session, without asking
  off      Ask once a session before starting it (the default)
  install  Install or update it now
  status   Show the setting and what is installed (the default)
  help     Print this message or the help of the given subcommand(s)

Options:
      --config <CONFIG>
          Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json)
          
          [env: OPPX_CONFIG=]

  -h, --help
          Print help (see a summary with '-h')

oppx servers

List paired servers (tokens are never shown)

Usage: oppx servers [OPTIONS]

Options:
      --config <CONFIG>  Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json) [env: OPPX_CONFIG=]
  -h, --help             Print help

oppx use

Set the default server

Usage: oppx use [OPTIONS] <NAME>

Arguments:
  <NAME>  Server name, as listed by `oppx servers`

Options:
      --config <CONFIG>  Config file (defaults to the user config dir, e.g. ~/.config/oppx/config.json) [env: OPPX_CONFIG=]
  -h, --help             Print help