- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Scaffold, validate, refresh, review, and manage low-code agents using the `uip agent` tool.
uip agent is the Agent tool: it scaffolds, validates, migrates, and reviews low-code agents — the agent.json-driven projects authored in Agent Builder / Studio Web. Install it with uip tools install agent, or invoke uip agent … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.
This tool is distinct from the coded agent tool (uip codedagent), which targets Python agents built with LangGraph / LlamaIndex / OpenAI Agents. uip agent only operates on low-code agent projects: a directory containing agent.json, entry-points.json, project.uiproj, an evals/ tree, and features/ / resources/ folders — or, for an agent embedded in a Maestro Flow, a UUID-named subdirectory inside the flow project (--inline-in-flow).
uip agent has no pack, publish, deploy, push, pull, run, list, share, file, config, context, escalation, input, or output command — packaging and shipping an agent project goes through uip solution instead (the agent project is one project inside a solution). Resource authoring (tools, contexts, escalations, I/O schema) is done by hand-editing agent.json, not through a dedicated CLI verb.
What a UiPath Agent is
A low-code agent is described declaratively by a single agent.json file — model, prompts, input/output schemas, tools, contexts, escalations, and settings. Supporting files describe the entry points that Studio Web uses to invoke the agent, the default evaluation set, and any RAG / HITL resources.
The real lifecycle covered by uip agent is:
- Scaffold a project on disk with
uip agent init(standalone, or--inline-in-flowinside a Maestro Flow project). By default the project auto-registers into a surrounding solution's.uipx, or a new<Name>Solutionis scaffolded automatically when none exists. - Author by hand-editing
agent.json(and the files underresources/,evals/). - Refresh the project (
uip agent refresh) after every edit — applies pending schema migrations and regeneratesentry-points.json/bindings_v2.json. This is the only command that writes derived files. - Validate the project (
uip agent validate) — strict, read-only: answers "would Studio Web accept this directory as-is?" without writing anything. - Review the project against a deterministic rule set (
uip agent review) for a scored quality verdict, and optionally record the grade over time (uip agent review-history add). - Configure LLM models (
uip agent model list), memory spaces (uip agent memory), guardrails (uip agent guardrails), and tools (uip agent tool list) as needed. - Debug the agent against Studio Web (
uip agent debug) to run it end-to-end with sample inputs before shipping. - Ship with
uip solution pack/publish/upload/deploy—uip agenthas no packaging or deployment verb of its own. - Evaluate the agent against an evaluation set (
uip agent eval run start) — works against a cloud-pushed solution (--solution-id, or auto-detected fromSolutionStorage.json) or, when neither is available, an implicit local-workspace evaluation path.
Verbs
| Command | Purpose |
|---|---|
| init | Scaffold a new agent project on disk (standalone, or inline inside a flow project). |
| validate | Strict read-only check: would Studio Web accept this project as-is? |
| refresh | Apply pending schema migrations and regenerate entry-points.json / bindings_v2.json. |
| review | Score the project against a deterministic rule set (verdict, score, grade, issues). |
| review-history | Record a review grade in the project's local review-history file. |
| tool list | List the tool resources configured on the agent. |
| memory | Attach, list, and remove memory spaces and memory items. |
| eval | Manage evaluators, evaluation sets, test cases, and evaluation runs. |
| guardrails | List guardrail definitions, BYOG guardrails, LLM-as-judge models, and the guardrail catalog. |
| model | List LLM models available for the authenticated tenant. |
| debug | Run the agent against Studio Web with sample inputs and stream the result. |
Synopsis
uip agent <verb> [subverb] [arguments] [options]
uip agent <verb> [subverb] [arguments] [options]
Always uip agent, never uip agents or uip a. agent is the tool's commandPrefix (see uip tools list).
All uip agent verbs honor the four global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the shared contract.
End-to-end flow
# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4
# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent
# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent
# 4. Review for quality issues before shipping
uip agent review ./my-agent
# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .
# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait
# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'
# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4
# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent
# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent
# 4. Review for quality issues before shipping
uip agent review ./my-agent
# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .
# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait
# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'
Authentication
debug, eval run *, guardrails llm-as-judge-models, and model list call Studio Web / the LLM gateway and require an active CLI session. Run uip login first. See Authentication for the session model.
init, validate, refresh, review, review-history, tool list, memory, guardrails list, and guardrails catalog are local-only and do not require a session.
See also
- Concepts: tools (plugins) — the plugin model and version pinning.
- uip solution — packaging, publishing, and deploying the solution an agent project lives in.
- Authentication — sessions, tenants, and folders.
- Global options, Exit codes.