Skip to content

CLI

prudai is the command line for all products, for people and agents. The product commands are generated from the OpenAPI specification. The CLI runs on Node 20 or newer.

Terminal window
npx @prudai/cli --version # without installing
npm install --global @prudai/cli # or install it: the command is then called prudai
prudai --version
Terminal window
prudai login # Keycloak device login
prudai guide # the manual for agents
prudai products # products and number of operations
prudai ops search "risk" # search operations, with scope and approval level
prudai describe irma risks create # parameters, body and curl example
prudai irma risks list --limit 5 --json
GroupCommands
Discoverguide, products, ops search, ops list, describe
Productprudai <product> <object> <verb> for leo, irma and ordo
Rawapi <METHOD> <path> --product <product>
Loginlogin, logout, whoami, auth status, profile
Keyskeys scopes, keys list, keys create, keys rotate, keys revoke
Accountaccount, account members, account seats, account subscription, account billing
Usagecredits, usage, logs, invoices
Approvalsapprovals list, get, status, wait, execute, cancel; --wait on every write
MCPmcp --check, mcp connections
Agentskill install

What the platform does not serve yet, the CLI answers with not_available and exit 2. It never pretends. The command names per operation are in the reference.

  • --json gives exactly one JSON document: the envelope, also for help.
  • Writes are a dry run by default where the spec has one; otherwise nothing leaves. Really writing asks for --no-dry-run --yes.
  • Every write gets an Idempotency-Key. --idempotency-key reuses it.
  • Approvals: a 202 gives the link and the next command. The CLI never approves by itself and never pays.
  • No secrets in output. Credentials come from the environment or the config file, never from a flag.
CodeMeaning
0Done
1Network or server; check the state before you repeat a write
2You must do something: validation, login, refused, not_available, waiting approval

The CLI never logs in with a key. prudai keys manages service keys for your own applications, with your Keycloak login. You see the secret value once.