Skip to content

CLI

Installing the package puts a calimero-client-py command on your PATH (provided by the calimero package’s cli module). It is intentionally small — a thin wrapper for quick checks, not a full-featured CLI.

Terminal window
calimero-client-py [--base-url URL] [--node-name NAME] [--auth-mode {none,required}] <command>

With no command, it prints help.

  • --version — print the version and exit.
  • --base-url URL — the node’s base URL. Defaults to https://test.merod.dev.p2p.aws.calimero.network.
  • --node-name NAME — a stable node name used to locate cached JWT tokens. Required for authenticated nodes (see authentication); omit it for unauthenticated local nodes.
  • --auth-mode {none,required} — the authentication mode you expect (default none). The CLI probes the node’s actual mode and prints a warning to stderr if it differs; the node’s real mode is what’s used.

List the contexts on the target node. Prints the number of contexts followed by the raw response.

Terminal window
calimero-client-py --base-url http://localhost:2428 list-contexts
Terminal window
# Show the version
calimero-client-py --version
# Print help
calimero-client-py --help
# List contexts on a local node
calimero-client-py --base-url http://localhost:2428 list-contexts