uip rpa cleanup

Syntax and options for `uip rpa cleanup`, which removes unused items from a UiPath Studio project, or only detects them with `--dry-run`.

uip rpa cleanup removes unused items from a UiPath Studio project. It modifies the project sources in place. Pass --dry-run to only detect the unused items and leave every project file unchanged.

Synopsis

uip rpa cleanup [project-dir] [options]

• [project-dir] — path to the project directory, its project.json file, or a .uip archive. Defaults to --project-dir, or the current directory. A .uip archive is accepted only with --dry-run.

Options

Flag	Description
--dry-run	Detect unused items without modifying any project files.
--skip-imports	Keep references to the removed items in the project's files, instead of cleaning up the references that become unused.
--project-dir <path>	Path to the project directory. Alternative to the positional argument.
--exclude-configured-sources	Ignore user and machine NuGet sources during dependency resolution.
--nuget-sources-config-path <path>	Path to a NuGet sources configuration file.
--feed-folder <name>	Resolve library dependencies from this Orchestrator folder's feed instead of every tenant feed. Accepts a folder name or a fully qualified path.
--log-level <level>	Log level. Defaults to Warn.

For the complete option list on your installed tool version, run:

uip rpa cleanup --help

Examples

# List the unused items in the project in the current directory, without changing anything
uip rpa cleanup --dry-run

# Remove the unused items from a project
uip rpa cleanup ./MyProject

# Check a .uip archive for unused items
uip rpa cleanup ./MyProject.uip --dry-run

Data shape (--output json)

Field	Description
Success	true when the cleanup completed.
DryRun	true when the command ran with --dry-run and changed no files.
UnusedItems	The unused items found in the project.
CleanedFiles	The project files the cleanup modified. Empty with --dry-run.
ToolDetails	Additional details from the packager, when it reports any.

Running without --dry-run against a .uip archive fails with exit code 1, because an archive can't be cleaned in place.

Related

• uip rpa build — compile the project after a cleanup.
• uip rpa pack — package the project.
• uip rpa — the full list of uip rpa commands.