Back to docsCLI

PatchOps CLI.

Reach every connector from the terminal. Install, sign in, and make your first structured call in three commands.

Quickstart

From zero to first call.

1

Install

Install the CLI globally from npm. Node 18+ is all you need.

@patchops/cli

Terminal

npm install -g @patchops/cli
2

Sign in

Authenticate with PatchOps, then list the tools you can reach to confirm the connection.

patchops login

Terminal

patchops login
patchops tools list
3

Call a connector

Run any connector method from the terminal. Pass arguments as JSON; PatchOps returns the structured result, logs, and timing.

patchops invoke

Terminal

patchops invoke welldatabase getOperatorWells --input '{
  "county": "Loving",
  "operator": "Mitsui"
}'
What you get

One sign-in, every connector

patchops login once and every connected provider is reachable from the terminal.

Structured results

Calls return JSON output plus logs and timing, ready to pipe into your own tools.

Isolated session

Your CLI session stays separate from the browser, and connector secrets never leave PatchOps.

Next steps