UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip rpa get-object-repository

Syntax and options for `uip rpa get-object-repository`, which returns the current project's own Object Repository as a JSON tree.

uip rpa get-object-repository returns the current project's own Object Repository — the applications, screens, and elements it defines — as a JSON tree. It excludes entries inherited from referenced libraries; use uip rpa get-library-object-repository to read those separately.

The verb runs inside a hosted project context on both backends (Studio's project process and Helm's project assembly load context), so a project must be open before it can be called.

Synopsis

uip rpa get-object-repository
uip rpa get-object-repository

Options

This verb takes no per-command options. Use the parent-level options shared by every uip rpa verb — see RPA tool overview.

Examples

# Read the current project's Object Repository
uip rpa get-object-repository
# Read the current project's Object Repository
uip rpa get-object-repository

Data shape (--output json)

The command returns the Object Repository tree exactly as objectRepository.getProjectObjects() produces it — apps, then screens, then elements, nested to match the repository's own structure. Shape is otherwise unspecified and may evolve with the Object Repository feature itself; inspect a real project's output rather than relying on a fixed schema.

On failure (for example, no project is open), the command reports:

{
  "success": false,
  "errorMessage": "<reason>"
}
{
  "success": false,
  "errorMessage": "<reason>"
}

See also

  • Synopsis
  • Options
  • Examples
  • Data shape (--output json)
  • Related
  • See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated