uipath-cli
latest
false
UiPath CLI user guide
- 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 maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip rpa packages inspect
Syntax and options for `uip rpa packages inspect`, which generates Markdown documentation for every public type and method in a NuGet package.
uip rpa packages inspect reflects over a NuGet package and produces Markdown documentation for every public type, method, property, and enum it exposes. The package can be pulled from a configured feed (--package-name plus --package-version) or read directly off disk (--nupkg-path) — useful when you need to verify what an activity package actually exposes before writing or generating workflows against it.
Reflection is performed via Studio, so the verb requires a Windows runner.
Synopsis
uip rpa packages inspect [--package-name <string>] [--package-version <string>] [--feed-url <string>] [--nupkg-path <string>]
uip rpa packages inspect [--package-name <string>] [--package-version <string>] [--feed-url <string>] [--nupkg-path <string>]
Options
| Flag | Description |
|---|---|
--package-name <string> | NuGet package name, e.g. UiPath.Excel.Activities. Not required when --nupkg-path is provided. |
--package-version <string> | Package version, e.g. 3.3.1. Not required when --nupkg-path is provided. |
--feed-url <string> | Optional NuGet feed URL. Defaults to the UiPath Official feed. |
--nupkg-path <string> | Absolute path to a local .nupkg file. When set, the package is inspected directly without contacting any feed. |
For the complete option list on your installed tool version, run:
uip rpa packages inspect --help
uip rpa packages inspect --help
Examples
# Inspect a published activity package from the default feed
uip rpa packages inspect \
--package-name UiPath.Excel.Activities \
--package-version 3.3.1
# Inspect a local .nupkg before publishing
uip rpa packages inspect \
--nupkg-path C:\artifacts\MyOrg.Activities.1.0.0.nupkg
# Inspect a published activity package from the default feed
uip rpa packages inspect \
--package-name UiPath.Excel.Activities \
--package-version 3.3.1
# Inspect a local .nupkg before publishing
uip rpa packages inspect \
--nupkg-path C:\artifacts\MyOrg.Activities.1.0.0.nupkg
Related
uip rpa packages versions— list available versions before picking one to inspect.uip rpa packages install— install the inspected package into a project.uip rpa pack— produce the.nupkgyou might want to inspect locally.