Insights

Introducing the Orq.ai CLI

The Orq.ai CLI covers the entire Orq.ai API, and ships the Orq.ai Skills inside the binary so your coding agent knows how to use it.

Blog post cover image

Key Takeaways

The Orq.ai CLI covers the entire Orq.ai API, so deployments, traces, datasets, evaluators, and Gateway settings are all one command away.

It's built for coding agents as much as for people. The Orq.ai skills ship inside the binary, so your agent knows which command to run and which workflow it belongs to.

Two commands get you from nothing to working. Install the binary, then run orq setup.

Summarize with AI

Open this article in your preferred AI assistant.

The Orq.ai CLI can do anything the Orq.ai API can do, and more. Manage prompts, agents, deployments, knowledge bases, evaluators, traces, and the rest of the platform from a terminal, CI, or scripts. It's generated from the full OpenAPI spec, so every endpoint is a command.

Two kinds of work get easier. The first is your own. The whole platform is manageable from the terminal, so you check which prompt version is live, pull a failing trace, or fire a completion to confirm routing works, quicker than any trip through the UI.

The second is your coding agent's. The CLI combined with Orq.ai Skills gives an agent both the commands and the best practices for using them, so it knows what to run and in what order. You describe the outcome, it drives the CLI. For a tool that can't run commands or install packages, orq connect mcp registers the Orq.ai MCP server instead.

Start using it

Install the binary and wire up your workspace.

curl -fsSL https://cli.orq.ai/install.sh | sh

curl -fsSL https://cli.orq.ai/install.sh | sh

curl -fsSL https://cli.orq.ai/install.sh | sh

curl -fsSL https://cli.orq.ai/install.sh | sh

Or install it from npm.

npm install -g

npm install -g

npm install -g

npm install -g

orq setup signs you in, creates a workspace API key, and configures the coding agents already on your machine to route their model calls through the Orq.ai Gateway.


Installing the Orq.ai CLI and running orq setup

What it looks like in practice

# Call any model your workspace allows, through the Gateway
orq responses create --model openai/gpt-5-mini --input "ping"

# See which agents are live, then run one
orq agents list
orq responses create --model agent/<agent_key> --input "where is my order?"

# Find what that run cost, and read the trace it left behind
orq traces search --from <start> --to <end> --limit 20
orq traces get <trace_id>

# Ask what the month cost, broken down by model
orq reporting query --metric genai.cost \
  --mode scalar --group-by model --include-totals \
  --from <start> --to <end>

# Cap a project at 500 dollars a month
orq budgets create --scope '{"project":{"project_id":"<project_id>"}}' \
  --limits '{"amount":500,"period":"BUDGET_PERIOD_MONTHLY"}'
# Call any model your workspace allows, through the Gateway
orq responses create --model openai/gpt-5-mini --input "ping"

# See which agents are live, then run one
orq agents list
orq responses create --model agent/<agent_key> --input "where is my order?"

# Find what that run cost, and read the trace it left behind
orq traces search --from <start> --to <end> --limit 20
orq traces get <trace_id>

# Ask what the month cost, broken down by model
orq reporting query --metric genai.cost \
  --mode scalar --group-by model --include-totals \
  --from <start> --to <end>

# Cap a project at 500 dollars a month
orq budgets create --scope '{"project":{"project_id":"<project_id>"}}' \
  --limits '{"amount":500,"period":"BUDGET_PERIOD_MONTHLY"}'
# Call any model your workspace allows, through the Gateway
orq responses create --model openai/gpt-5-mini --input "ping"

# See which agents are live, then run one
orq agents list
orq responses create --model agent/<agent_key> --input "where is my order?"

# Find what that run cost, and read the trace it left behind
orq traces search --from <start> --to <end> --limit 20
orq traces get <trace_id>

# Ask what the month cost, broken down by model
orq reporting query --metric genai.cost \
  --mode scalar --group-by model --include-totals \
  --from <start> --to <end>

# Cap a project at 500 dollars a month
orq budgets create --scope '{"project":{"project_id":"<project_id>"}}' \
  --limits '{"amount":500,"period":"BUDGET_PERIOD_MONTHLY"}'
# Call any model your workspace allows, through the Gateway
orq responses create --model openai/gpt-5-mini --input "ping"

# See which agents are live, then run one
orq agents list
orq responses create --model agent/<agent_key> --input "where is my order?"

# Find what that run cost, and read the trace it left behind
orq traces search --from <start> --to <end> --limit 20
orq traces get <trace_id>

# Ask what the month cost, broken down by model
orq reporting query --metric genai.cost \
  --mode scalar --group-by model --include-totals \
  --from <start> --to <end>

# Cap a project at 500 dollars a month
orq budgets create --scope '{"project":{"project_id":"<project_id>"}}' \
  --limits '{"amount":500,"period":"BUDGET_PERIOD_MONTHLY"}'

These are just example commands. You can find all of them in the CLI reference, and every command documents its flags with --help. The CLI itself is on GitHub, which is also where bug reports and feature requests go.

Wire your coding agents

orq setup already ran this for the agents it found. orq connect is the command underneath, and you can rerun it per agent or per capability whenever your machine changes.

orq connect                 # every detected agent: gateway, skills, mcp
orq connect claude skills   # one agent, one capability
orq connect --dry-run       # the files that would change, nothing written
orq connect --status        # what's wired on this machine
orq disconnect              # take it all back out
orq connect                 # every detected agent: gateway, skills, mcp
orq connect claude skills   # one agent, one capability
orq connect --dry-run       # the files that would change, nothing written
orq connect --status        # what's wired on this machine
orq disconnect              # take it all back out
orq connect                 # every detected agent: gateway, skills, mcp
orq connect claude skills   # one agent, one capability
orq connect --dry-run       # the files that would change, nothing written
orq connect --status        # what's wired on this machine
orq disconnect              # take it all back out
orq connect                 # every detected agent: gateway, skills, mcp
orq connect claude skills   # one agent, one capability
orq connect --dry-run       # the files that would change, nothing written
orq connect --status        # what's wired on this machine
orq disconnect              # take it all back out

Six agents are supported today. Claude Code, Codex, OpenCode, Kimi Code, Kilo, and Pi.

Upgrade

Upgrading is a command rather than a hunt for release notes. It replaces the binary using whichever method installed it, npm or the install script.

$ orq update --check     # what's available, changes nothing
$ orq update             # replace this binary
$ orq update --check     # what's available, changes nothing
$ orq update             # replace this binary
$ orq update --check     # what's available, changes nothing
$ orq update             # replace this binary
$ orq update --check     # what's available, changes nothing
$ orq update             # replace this binary

The CLI also checks its own version at startup and tells you when you're behind.

When something is off, orq doctor inspects config, auth state, and endpoint reachability in one pass. orq doctor --fix tightens the permissions on your credential files, and --report prints a pre-filled issue URL so a bug report takes one paste.

Pair it with Agent Skills

The CLI is more useful when the agent in your terminal knows how to use it. Orq.ai Skills are the instructions that teach an agent the platform, which command to reach for, which workflow to follow, and what to do with the result. They arrive with the CLI rather than being downloaded each session, so they work offline and stay current. Add them by running orq connect skills.

Moving forward

Issues and feature requests go to the CLI repo; if you don't have an account yet, start at my.orq.ai.

Arian Pasquali image

Arian Pasquali

Research Engineer

About

Research Engineer at Orq.ai specializing in AI agents and LLM evaluation, with a background in consulting and academia across NLP and IR.

Create an account and start building today.

Create an account and start building today.

Create an account and start building today.

Create an account and start building today.