- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip docsai
- 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-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
UiPath CLI user guide
uip agent config reads and updates individual keys in an agent project's agent.json. It is a convenience for automation and scripts: everything it does can also be accomplished by hand-editing agent.json, but the verbs understand the file's structure (settings, metadata, messages) and expose a flat key namespace.
Synopsis
uip agent config get [key] [--path <dir>]
uip agent config set <key> <value> [--path <dir>]
uip agent config get [key] [--path <dir>]
uip agent config set <key> <value> [--path <dir>]
All uip agent config subcommands honor the global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the standard contract.
uip agent config get
Read a single key (or the full curated summary) from agent.json.
Arguments
[key](optional) — Config key. Known keys includemodel,name,systemPrompt, and any other nested path thatagent.jsonsupports (runuip agent config getwithout a key for a curated summary). Omit to print that summary.
Options
| Flag | Default | Purpose |
|---|---|---|
--path <path> | . | Path to the agent project directory. |
Examples
# Read a single key
uip agent config get model --path ./my-agent
# Dump the curated summary for the current directory
uip agent config get
# Read a single key
uip agent config get model --path ./my-agent
# Dump the curated summary for the current directory
uip agent config get
Data shape (--output json)
Single key (Code: "AgentConfigGet"):
{
"Code": "AgentConfigGet",
"Data": {
"Key": "model",
"Value": "gpt-4o-2024-11-20"
}
}
{
"Code": "AgentConfigGet",
"Data": {
"Key": "model",
"Value": "gpt-4o-2024-11-20"
}
}
Summary (no key):
{
"Code": "AgentConfigGet",
"Data": {
"Name": "my-agent",
"Description": "-",
"Model": "gpt-4o-2024-11-20",
"Engine": "advanced",
"MaxTokens": "-",
"Temperature": "-",
"SystemPrompt": "You are…",
"UserPrompt": "-"
}
}
{
"Code": "AgentConfigGet",
"Data": {
"Name": "my-agent",
"Description": "-",
"Model": "gpt-4o-2024-11-20",
"Engine": "advanced",
"MaxTokens": "-",
"Temperature": "-",
"SystemPrompt": "You are…",
"UserPrompt": "-"
}
}
SystemPrompt and UserPrompt are the content fields of the system and user entries in agent.json's messages[] array, truncated to 120 characters. Any missing value renders as -.
uip agent config set
Update a key in agent.json. The value is written verbatim — no type coercion beyond the CLI's built-in normalization.
Arguments
<key>(required) — Config key to write. Same namespace asget.<value>(required) — New value.
Options
| Flag | Default | Purpose |
|---|---|---|
--path <path> | . | Path to the agent project directory. |
Examples
# Swap the model on a scaffolded agent
uip agent config set model gpt-4o-2024-11-20 --path ./my-agent
# Rename the agent (metadata.name)
uip agent config set name "Invoice Triage" --path ./my-agent
# Swap the model on a scaffolded agent
uip agent config set model gpt-4o-2024-11-20 --path ./my-agent
# Rename the agent (metadata.name)
uip agent config set name "Invoice Triage" --path ./my-agent
Data shape (--output json)
{
"Code": "AgentConfigSet",
"Data": {
"Key": "model",
"Value": "gpt-4o-2024-11-20",
"Status": "Updated"
}
}
{
"Code": "AgentConfigSet",
"Data": {
"Key": "model",
"Value": "gpt-4o-2024-11-20",
"Status": "Updated"
}
}
The CLI does not re-validate agent.json after a set. Run uip agent validate afterwards to confirm the project is still internally consistent (contentTokens, entry-points.json sync, etc.).
Related
uip agent validate— run static checks and schema migration after a batch ofconfig setcalls.uip agent init— scaffold a new project; many of the valuesconfig getexposes are written at init time.uip agent input/uip agent output— these verbs write the agent's I/O schemas, whichconfigdoes not manage.