Agent CLI
What it is
The Agent CLI lets AI coding agents such as Claude Code and Codex list and inspect your workspaces, collections, requests, environments and Conduits (E2E tests), send saved requests, and run Conduits using your local Nidra data. It works with the app closed.
Install
Installing the command is free on every plan.
- Windows: The installer adds
nidrato PATH. Open a new terminal after installing. - macOS and Linux: Open Settings → Agent CLI → "Install nidra command".
- macOS without admin rights: Choose "Install without admin rights" to install to
~/.local/bin, then copy the PATH line shown into your shell configuration.
Start with nidra agent-help.
Commands
| Command | What it does | Plan |
|---|---|---|
nidra agent-help | Show help for AI agents | Free |
nidra workspaces | List workspaces | Free |
nidra collections | List collections | Free |
nidra requests | List saved requests | Free |
nidra request show | Inspect a saved request | Free |
nidra environments | List environments | Free |
nidra environment show | Inspect an environment | Free |
nidra send | Send a saved request | Free |
nidra conduits | List Conduits | Free |
nidra conduit run | Run a Conduit (E2E test) | Professional (trial included) |
Use the --json flag for JSON output.
Every command also accepts --workspace NAME; the active workspace is used by default.
Sending a request with different path values
nidra send accepts --path name=value to set a path variable for that one send. Repeat it for several variables.
It only works for path variables the saved request already has, written as {name} or :name in the URL. An unknown name is refused, and the error lists the request's path variables.
The value is used exactly as typed. It is never filled in from an environment or KeyVault, so {{URL}} goes out as literal text. It is encoded as one part of the address, so characters like /, ? and # can't add extra path parts or a query string.
Empty values, . and .. are refused.
A path value can never change the server the request goes to. If it would change the scheme, host or port, Nidra refuses before sending anything.
Nothing is saved. The request in Nidra keeps its saved value.
This applies only to nidra send, not nidra conduit run.
nidra send "Get order" --collection "Orders API" --env "Staging" --path orderId=2002
Requires Nidra 1.6.1 or later.
Free vs Professional
Only nidra conduit run needs Professional; trial users get Professional access. On Free, it stops with a message asking you to upgrade or start a trial (JSON error code pro_required, exit code 3). Everything else works on Free.
Safety
Agents never see secrets. Auth, KeyVault values and variables are filled in inside Nidra, and secret values are hidden in output.
Each environment has an Agent access setting: Full, Read-only, or Blocked. Read-only is the default and allows only GET, HEAD and OPTIONS. Only a person in the app can change this setting. It is stored per machine and never synced.
Requests redirected to a different server are refused.
Path values set with --path can't change which server a request is sent to.