UiPath CLI - uip maestro registry

uipath-cli

latest

false

UiPath CLI user guide

uip maestro registry

Syntax and options for `uip maestro registry`, which downloads, locates, searches, and prepares the connector library that Flow, Case, and BPMN authoring commands read.

uip maestro registry manages the connector library shared by the Flow, Case, and BPMN authoring commands. pull downloads the library into a shared cache and generates the TypeScript connector descriptors a project imports. prepare resolves one connector operation against a live connection, for schemas the shipped library can't know, such as custom objects.

This group is different from the family registries, uip maestro flow registry, uip maestro bpmn registry, and uip maestro case registry, which browse the node and task types each designer offers.

The commands run through the builder SDK and have the same requirements as the authoring commands: @uipath/maestro-builder-sdk 6.11.1 or later, in the project or installed globally.

Synopsis

uip maestro registry pull    [--connector <key>]... [--connectors <dir>] [--force] [options]
uip maestro registry search  [query...] [--connector <key>] [--limit <n>] [--library <dir>] [--library-md <dir>]
uip maestro registry path    [--library-json | --library-md | --root | --sha]
uip maestro registry prepare <connector-key> --action <name> [options]
uip maestro registry pull    [--connector <key>]... [--connectors <dir>] [--force] [options]
uip maestro registry search  [query...] [--connector <key>] [--limit <n>] [--library <dir>] [--library-md <dir>]
uip maestro registry path    [--library-json | --library-md | --root | --sha]
uip maestro registry prepare <connector-key> --action <name> [options]

All invocations honor the global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the standard contract.

Each command returns Code: "Registry<Verb>", for example RegistryPull, with the builder SDK's result in Data. Progress messages go to stderr.

uip maestro registry pull

Download the connector library into the shared cache and generate the descriptors the project imports.

Options

Option	Description
`--connectors <dir>`	TypeScript descriptor output directory. Default: `./connectors`.
`--connector <key>`	Generate only this connector. Repeatable. Default: the connectors the project references.
`--force`	Download and generate again.
`--library <dir>`	Extract the library to this directory instead of the shared cache.
`--library-md <dir>`	Generate the Markdown library in this directory instead.
`--url <url>`	Archive URL to pull from.
`--archive <zip>`	Use an archive already on disk.
`--cache <dir>`	Directory where downloaded archives are kept.
`--root <prefix>`	Extract only archive entries under this prefix.
`--import <specifier>`	Module specifier for the generated descriptors.
`--triggers <path>`	`registry-triggers.json` file for triggers.
`--python <executable>`	Python interpreter for the generators.
`--extractor <path>`	`extract_library.py` to run instead of the packaged copy.
`--generator <path>`	`materialize_registry.py` to run instead of the packaged copy.

Example

uip maestro registry pull --connector uipath-salesforce-slack
uip maestro registry pull --connector uipath-salesforce-slack

Data shape (--output json)

{
  "Code": "RegistryPull",
  "Data": {
    "Sha256": "f2ae49be22ec…",
    "Library": "~/.uipath/cache/flow-sdk/library/f2ae49be22ec…/library-json",
    "LibraryMarkdown": "~/.uipath/cache/flow-sdk/library/f2ae49be22ec…/library-md",
    "MadeCurrent": true,
    "Connectors": "/work/connectors",
    "Generated": ["uipath-salesforce-slack"]
  }
}
{
  "Code": "RegistryPull",
  "Data": {
    "Sha256": "f2ae49be22ec…",
    "Library": "~/.uipath/cache/flow-sdk/library/f2ae49be22ec…/library-json",
    "LibraryMarkdown": "~/.uipath/cache/flow-sdk/library/f2ae49be22ec…/library-md",
    "MadeCurrent": true,
    "Connectors": "/work/connectors",
    "Generated": ["uipath-salesforce-slack"]
  }
}

uip maestro registry search

Find connector operations in the cached library.

Arguments

[query...] (optional) — search words.

Options

Option	Description
`--connector <key>`	Search one connector only.
`--limit <n>`	Maximum number of results.
`--library <dir>`	`library-json` directory. Default: the cache.
`--library-md <dir>`	Markdown library directory.

Example

uip maestro registry search slack send message --limit 5
uip maestro registry search slack send message --limit 5

Data shape (--output json)

{
  "Code": "RegistrySearch",
  "Data": { "Total": 2, "Operations": ["…"] }
}
{
  "Code": "RegistrySearch",
  "Data": { "Total": 2, "Operations": ["…"] }
}

uip maestro registry path

Print where the cached connector library is.

Options

Option	Description
`--library-json`	Print only the `library-json` directory.
`--library-md`	Print only the Markdown directory.
`--root`	Print only the cache root.
`--sha`	Print only the checksum of the current library.

Example

# Print the Markdown library directory with no envelope, for $(…) capture
uip maestro registry path --library-md --output plain
# Print the Markdown library directory with no envelope, for $(…) capture
uip maestro registry path --library-md --output plain

Data shape (--output json)

{
  "Code": "RegistryPath",
  "Data": { "LibraryMarkdown": "~/.uipath/cache/flow-sdk/library/current/library-md" }
}
{
  "Code": "RegistryPath",
  "Data": { "LibraryMarkdown": "~/.uipath/cache/flow-sdk/library/current/library-md" }
}

uip maestro registry prepare

Resolve one operation's schema against a live connection and write it to the ./connectors-local overlay. By default, the command also records the connection in bindings.json. The authoring commands read the overlay through --connectors-local.

Arguments

<connector-key> (required) — the connector key, for example uipath-salesforce-sfdc.

Options

Operation and schema:

Option	Description
`--action <name>`	Operation to resolve, for example `insert-record`. Required. Pass it once.
`--object <name>`	One object discovered through the connection.
`--all-objects`	Every object discovered through the connection.
`-f, --field <name=value>`	Parent field that selects the schema. Repeatable.
`--resolve <field:by=value>`	Resolve a lookup field to the ID the connector expects. Repeatable.
`--refresh-lookups`	Resolve again the lookups already recorded in `resolutions.json`.
`--connector-version <version>`	Connector version to resolve against.

Connection and bindings:

Option	Description
`--connection-id <id>`	Connection to read the schema through. Default: discovered.
`--connection <name>`	Connection name, when more than one connection matches.
`--connection-folder <folder>`	Folder name or key the flow runs in, when more than one connection matches.
`--bindings <file>`	Bindings file to update. Default: `./bindings.json`.
`--bind-connection <name>`	Symbolic connection name. Default: the connector suffix.
`--bind-folder <name>`	Symbolic folder name. Default: `shared`.
`--no-bindings`	Discover the connection, but leave `bindings.json` unchanged.

Output:

Option	Description
`--out <dir>`	Overlay directory. Default: `./connectors-local`.
`--json-only`	Write the JSON overlay without TypeScript.
`--import <specifier>`	Module specifier for the descriptors.
`--python <executable>`	Python interpreter for the generator.
`--generator <path>`	`prepare_connector.py` to run instead of the packaged copy.

Examples

# Resolve a Salesforce custom object
uip maestro registry prepare uipath-salesforce-sfdc --action insert-record --object Company__c

# Resolve Slack lookup fields to IDs and pick one of several connections
uip maestro registry prepare uipath-salesforce-slack --action send-message-to-channel \
  --connection is-sandboxes --resolve channel:name=general --resolve send_as:name=user
# Resolve a Salesforce custom object
uip maestro registry prepare uipath-salesforce-sfdc --action insert-record --object Company__c

# Resolve Slack lookup fields to IDs and pick one of several connections
uip maestro registry prepare uipath-salesforce-slack --action send-message-to-channel \
  --connection is-sandboxes --resolve channel:name=general --resolve send_as:name=user

Data shape (--output json)

{
  "Code": "RegistryPrepare",
  "Data": {
    "Connector": "uipath-salesforce-sfdc",
    "Action": "insert-record",
    "Overlay": "/work/connectors-local"
  }
}
{
  "Code": "RegistryPrepare",
  "Data": {
    "Connector": "uipath-salesforce-sfdc",
    "Action": "insert-record",
    "Overlay": "/work/connectors-local"
  }
}

Maestro authoring commands — compile, check, decompile, and merge.
uip maestro flow, uip maestro case, uip maestro bpmn

PREVIOUSuip maestro authoring

NEXTuip model-hub

Synopsis​

uip maestro registry pull​

Options​

Example​

Data shape (--output json)​

uip maestro registry search​

Arguments​

Options​

Example​

Data shape (--output json)​

uip maestro registry path​

Options​

Example​

Data shape (--output json)​

uip maestro registry prepare​

Arguments​

Options​

Examples​

Data shape (--output json)​

Related​

Was this page helpful?

Synopsis

uip maestro registry pull

Options

Example

Data shape (--output json)

uip maestro registry search

Arguments

Options

Example

Data shape (--output json)

uip maestro registry path

Options

Example

Data shape (--output json)

uip maestro registry prepare

Arguments

Options

Examples

Data shape (--output json)

Related