Skip to content

Use the Worre CLI

See what is deployed across Azure DevOps environments, what is happening next, and which builds are waiting for approval.

Download the Windows installer and run it. The installer bundles the desktop app and worre-cli.exe. Open a new PowerShell window after installing and check that the CLI is available. On an existing installation, use the in-app update and let Worre restart. Then open a new terminal window to use the CLI.

Terminal window
worre-cli --help

If your terminal still has the old PATH, restart the terminal application. For a default installation, you can also use the full path.

Terminal window
& "$env:LOCALAPPDATA\Programs\Worre\worre-cli.exe" --help

Create a short-lived, organisation-scoped personal access token (PAT) in Azure DevOps Services.

  • View deployments and approvals: Build (Read) and Environment (Read & manage).
  • Approve runs: Build (Read & execute), Pipeline Resources (Use), and Project and Team (Read).

Your account also needs access to the project and environments. To approve a run, you must be an eligible approver. Cancelling older runs also requires permission to stop builds.

Use your organisation’s policy for PATs. For an interactive PowerShell session, enter the PAT at the masked prompt. For automation, inject WORRE_PAT from your secret store.

Terminal window
$token = Read-Host "Azure DevOps PAT" -AsSecureString
$env:WORRE_PAT = [pscredential]::new('worre', $token).GetNetworkCredential().Password
Remove-Variable token

See Microsoft’s PAT guide and approval API permissions.

Terminal window
worre-cli overview "my-org/My Project"

Each row is a pipeline and each column is an environment. The value before > is the last successful deployment. The value after it shows newer activity, such as a deployment in progress, a failure, or a build waiting for approval.

Terminal window
worre-cli approvals "my-org/My Project/Production"
worre-cli approvals "my-org/My Project/Production/Folder/My Pipeline"

Use the Azure DevOps environment name. The pipeline path is optional. Copy the integer in the first column, Build ID.

Terminal window
worre-cli approve my-org 12345
worre-cli approve my-org 12345 --cancel-previous

Replace my-org with the organization name from https://dev.azure.com/my-org. PowerShell accepts a hyphen inside the name without quotes.

Approval takes effect immediately. If several targets match, use --stage to select a unique stage. With --cancel-previous, Worre confirms approval first, then requests cancellation for older builds still waiting on the same pipeline, branch, stage, and environment. The command reports the approval and cancellation requests.

For raw deployment history, use the numeric Environment ID from its Azure DevOps URL.

Terminal window
worre-cli deployments my-org "My Project" 42

5. Look up commands and clear the credential

Section titled “5. Look up commands and clear the credential”
Terminal window
worre-cli --help
worre-cli approve --help
Remove-Item Env:WORRE_PAT

Overview and approvals print tables. Deployment history prints JSON. Errors go to standard error and return a nonzero exit code, so scripts can check $LASTEXITCODE.