UiPath Object Repository CLI Tool

Project description

cpmf-uisor

CLI tool for UiPath Object Repository .objects/ directories. Reads, audits, and modifies Screen URLs (V2) and Element selectors (V6).

File named !README.md to appear first in GitHub Gist (lexicographic sort).

Installation

Requires Python 3.11+. Run directly with uv:

uv run cpmf-uisor --help

Object Repository Structure

UiPath stores UI automation targets in .objects/ with this hierarchy:

.objects/
  {hash}/          # App
    .type          # Contains "App"
    .metadata      # XML: Name, Reference
    {hash}/        # AppVersion
      .type        # Contains "AppVersion"
      .metadata    # XML: Name, Reference, ParentRef
      {hash}/      # Screen
        .type      # Contains "Screen"
        .metadata  # XML: Name, Reference, ParentRef
        .data/ObjectRepositoryScreenData/.content   # V2: URL, Selector
        {hash}/    # Element
          .type    # Contains "Element"
          .metadata
          .data/ObjectRepositoryTargetData/.content # V6: Selectors

Commands

inventory

List objects with parameterization status.

# Flat text (default)
cpmf-uisor inventory path/to/project.json

# Filter by type
cpmf-uisor inventory path/to/project.json --type screen
cpmf-uisor inventory path/to/project.json --type element

# Output formats
cpmf-uisor inventory path/to/project.json --format text       # Flat text
cpmf-uisor inventory path/to/project.json --format json       # Flat JSON array
cpmf-uisor inventory path/to/project.json --format tree       # Hierarchical text
cpmf-uisor inventory path/to/project.json --format json-tree  # Hierarchical JSON
cpmf-uisor inventory path/to/project.json --format markdown   # Writes Documentation/inventory.md
cpmf-uisor inventory path/to/project.json --format html       # Writes Documentation/inventory.html

audit

Report statistics and issues.

cpmf-uisor audit path/to/project.json
cpmf-uisor audit path/to/project.json --type screen
cpmf-uisor audit path/to/project.json --exit-code  # Exit 1 if issues found

Output includes:

Total objects (Screens, Elements)
Hardcoded vs parameterized counts
Variables in use
Version distribution
Issues (unsupported versions, literal * in URLs)

replace

Apply parameterization rules. Dry-run by default.

# Dry-run with config file
cpmf-uisor replace path/to/project.json --config rules.toml

# Apply changes
cpmf-uisor replace path/to/project.json --config rules.toml --apply

# Interactive mode (prompt per object)
cpmf-uisor replace path/to/project.json --config rules.toml --apply --interactive

# Interactive rule creation (no config file)
cpmf-uisor replace path/to/project.json --interactive

# Include unsupported versions
cpmf-uisor replace path/to/project.json --config rules.toml --force

Rules Configuration (TOML)

Three rule types modify .content files. Rules are evaluated in order; first matching rule wins.

Type	Purpose	Required Fields
`parameterize`	Hardcoded value → `[variable]`	`match`, `variable`
`rename`	`[oldVar]` → `[newVar]`	`from_variable`, `to_variable`
`reset`	`[variable]` → hardcoded value	`variable`, `value`

Targets

Target	Applies To
`all` (default)	Screen URLs + Element selectors
`screen`	V2 Screen URLs only
`element.scope`	V6 `ScopeSelectorArgument` only
`element.selector`	V6 `FullSelectorArgument` only

Examples

# Parameterize base URL (wildcard preserves path suffix)
# https://cms.example.com/app/login → [cmsBaseUrl]login
[[rules]]
type = "parameterize"
match = "https://cms.example.com/app/*"
variable = "cmsBaseUrl"

# Parameterize element title attribute in scope selector
# <html title='Login Page - CMS' /> → <html title='[windowTitle]' />
[[rules]]
type = "parameterize"
target = "element.scope"
attribute = "title"
match = "Login Page*"
variable = "windowTitle"

# Rename variable across all types
[[rules]]
type = "rename"
from_variable = "oldBaseUrl"
to_variable = "baseUrl"

# Reset variable to hardcoded value
[[rules]]
type = "reset"
variable = "testUrl"
value = "https://test.example.com/"

Variable Syntax

Both V2 Screens and V6 Elements use [expression] syntax. The expression can be:

Simple variable: [baseUrl]
Config lookup: [Config("CmsBaseUrl").ToString()]
Any VB.NET expression UiPath accepts

Examples:

V2 Screen URL: [baseUrl]pages/login.xhtml
V6 Selector attribute: <html title='[windowTitle]' />

XML special characters (", <, >, &, ') in variable expressions are automatically escaped when writing to .content files.

Supported Versions

Type	Version	File
Screen	V2	`.data/ObjectRepositoryScreenData/.content`
Element	V6	`.data/ObjectRepositoryTargetData/.content`

Unsupported versions are skipped by default. Use --force to include them.

Files

File	Purpose
`cli.py`	Typer CLI commands
`discovery.py`	Traverse `.objects/`, build hierarchy
`models.py`	Data classes (ScreenEntry, ElementEntry, Inventory)
`parser.py`	Parse `.metadata` and `.content` XML
`adapter_screen_V2.py`	V2 Screen URL handling
`adapter_element_V6.py`	V6 Element selector handling
`rules.py`	Load and apply TOML rules
`formatters.py`	Output formatters (text, JSON, markdown, HTML)
`templates.py`	Jinja2 templates for markdown/HTML

Project details

Release history Release notifications | RSS feed

This version

0.1.2

Jan 23, 2026

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cpmf_uisor-0.1.2.tar.gz (39.3 kB view details)

Uploaded Jan 23, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cpmf_uisor-0.1.2-py3-none-any.whl (39.0 kB view details)

Uploaded Jan 23, 2026 Python 3

File details

Details for the file cpmf_uisor-0.1.2.tar.gz.

File metadata

Download URL: cpmf_uisor-0.1.2.tar.gz
Upload date: Jan 23, 2026
Size: 39.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for cpmf_uisor-0.1.2.tar.gz
Algorithm	Hash digest
SHA256	`c65395b655cb21a99b5f4948cf21a25f7dc5a057064ad6e7d89a00ff62826feb`
MD5	`e2145d7561a2960acdb2bef3ef130671`
BLAKE2b-256	`8a90915a2a657fe9d0b46bfea29a99c7e4eccfe91651f357306308776bf7a0bb`

See more details on using hashes here.

File details

Details for the file cpmf_uisor-0.1.2-py3-none-any.whl.

File metadata

Download URL: cpmf_uisor-0.1.2-py3-none-any.whl
Upload date: Jan 23, 2026
Size: 39.0 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for cpmf_uisor-0.1.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`2839ee880a3c967f6f8e47c9619dc56b2cc87498d19fa44836b6b656c5622853`
MD5	`18d59dea0e24bf9c34fd44eb98f2c4f7`
BLAKE2b-256	`bb44db878194839098a8745d5a5d07dffed5064baaa9435ce414a150af1af498`

See more details on using hashes here.

cpmf-uisor 0.1.2

Navigation

Verified details

Owner

Unverified details

Meta

Project description

cpmf-uisor

Installation

Object Repository Structure

Commands

inventory

audit

replace

Rules Configuration (TOML)

Targets

Examples

Variable Syntax

Supported Versions

Files

Project details

Verified details

Owner

Unverified details

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes