orchcmd
The Command-Line Interface for UiPath Orchestrator
Stop clicking through the web UI. List triggers, restart jobs, watch queues, pull logs, and export Swagger — straight from your terminal.
What it does (live in your terminal)
orchcmd trigger list # what's scheduled?
orchcmd job list --state Running # what's running right now?
orchcmd job restart --name MyProcess # restart on the same machine
orchcmd queue stats Invoices # queue depth, in-progress, errors
orchcmd log list --name MyProcess # tail logs without leaving the shell
orchcmd swagger export -o api.json # grab the OpenAPI spec
If you've ever opened the Orchestrator UI just to read one log line and then closed it again — this tool is for you.
Built for UiPath admins who script
- Single binary, single install — drop into
%LOCALAPPDATA%\Programs\orchcmd\and runorchcmd --help. - On-Prem 2023.10 and UiPath Cloud — OAuth or legacy API-Key, both auto-detected.
- Self-signed certs accepted for typical on-prem installations.
- DPAPI credential encryption — no plaintext passwords on disk.
- Auto-update — installations pull signed releases from
updates.rpaops.dein the background. - Multi-folder operations —
--folder 7,8or--all-folders, no context switching. - Pipe-friendly — colored output when interactive, plain when scripted, meaningful exit codes.
- Built in Germany by an RPA practitioner who got tired of clicking.
Community vs. Pro
| Community | Pro | |
|---|---|---|
| Trigger / Job / Asset listing | ✓ | ✓ |
| Detail views, log viewer | ✓ | ✓ |
| Queue stats (single queue) | ✓ | ✓ |
| Swagger / OpenAPI export | ✓ | ✓ |
| Multi-folder operations | ✓ | ✓ |
| DPAPI credential encryption | ✓ | ✓ |
| Auto-update via stub launcher | ✓ | ✓ |
| Trigger enable / disable | — | ✓ |
| Job start / restart / stop / kill | — | ✓ |
| Restart on the same machine | — | ✓ |
| Process version updates | — | ✓ |
--watch monitor mode | — | ✓ |
Folder profiles (--profile) | — | ✓ |
Output profiles (--view) | — | ✓ |
| Multi-queue stats (wildcards, lists) | — | ✓ |
--since and --top time filters | — | ✓ |
| CSV export (assets, logs, queues, …) | — | ✓ |
| orchmon — Teams alerting | — | ✓ |
| orchhook — webhook auto-remediation | — | ✓ |
| Price | Free | €490/yr1 |
1 Single-developer license. Site licenses €1,990/yr. Every install starts as Pro for 30 days, then converts to Community unless you enter a license key.
Get the download
The Community Edition is yours, no strings attached. The Pro Edition starts as a 30-day trial on the same binary — same install path, same auto-updates. Enter a license key when the trial ends to keep the Pro features.
📧 Drop your email and we'll send the download link plus release notifications.
We email release notes, the occasional Pro tip, and launch discounts for early customers. No spam. One-click unsubscribe.
Why a CLI?
Because the web UI doesn't fit into:
- shell scripts that wait for a job to finish before triggering the next one
- CI/CD pipelines that promote process versions across folders
- monitoring dashboards that need queue depth as a CSV
- support sessions where you copy-paste a command instead of describing 12 clicks
- onboarding docs that show new admins the actual operations, not the UI of the month
The Orchestrator REST/OData API has been documented and stable for years. orchcmd is the thin, scriptable client that should have shipped with it.
Three things that surprise people
1. Job restart goes back to the same bot.
Out of the box, the Orchestrator API picks any free machine. orchcmd
binds the restart to the original HostMachineName so retries don't
shuffle workload across your fleet. Override with --any-machine or
--machine X when you actually want a different bot.
2. Multi-folder is the default, not an afterthought.
-f 7,8,15 runs the same command across three folders. --all-folders
spans every folder you have access to. No more re-running the same
command 14 times in a context-switch dance.
3. Auto-update is opt-out, not opt-in.
A tiny stub launcher checks once a day, downloads in the background, and activates the new version on the next start. SHA-256 verified, RSA signature-checked, atomic swap. You won't notice it ran.
FAQ
Does this work with UiPath Cloud?
Yes. It auto-detects whether you're on Cloud or On-Prem and chooses the right OData base URL.
Does it need a UiPath Robot on the machine?
No. orchcmd talks to the Orchestrator REST/OData APIs directly. It's a client tool, not a robot.
Can I script it from PowerShell / bash / Python?
Yes — exit codes are meaningful, output is pipe-friendly, and CSV export is built in (Pro). Output coloring auto-disables when stdout is redirected.
Where do credentials live?
In appsettings.json, optionally DPAPI-encrypted on Windows.
What .NET version?
.NET 8 Runtime (free, ~25 MB). The app is framework-dependent, so updates only ship app code, not a bundled runtime.
Is there a Linux build?
Currently Windows x64 only — that's where most UiPath admins live. If you need Linux, email me; it's on the radar.
What changes when my Pro trial ends?
The binary stays the same. Pro-only commands print a one-line upgrade hint instead of running. All read-only operations keep working as Community.
Be the first to know about new releases.
Early subscribers get launch discount codes for the Pro Edition.