Rundeck CLI Tool

This is the official CLI tool for Rundeck.

Documentation

https://rundeck.github.io/rundeck-cli/

• Changelog
• Install
• Configuration
• SSL Configuration
• Commands
• Scripting
• Java API Library
• Extensions

Bundled Extensions

• rd acl - Test and generate Rundeck ACL policy files

Javadoc

• rd-api-client
• rd-cli-lib

Downloads

Github Releases

For apt and yum repos, see Install

Homebrew installation

brew tap rundeck/rundeck-cli
brew install rundeck-cli

Howto

Build

Build with gradle

Produces packages in: rd-cli-tool/build/distributions:

rd-VERS.zip/.tar rundeck_cli_VERS.rpm rundeck_cli_VERS.deb

Produces Jars in: rd-cli-tool/build/libs: rundeck-cli-VERS-all.jar (shadowed jar)

./gradlew build

Update Dependency Verification

Dependency verification is automatically updated on Renovate branches by the Update dependency verification GitHub Actions workflow. That workflow needs a repository secret RENOVATE_PUSH_TOKEN (fine-grained PAT with Contents read/write) so its commit can trigger CI.

If you manually update a dependency, you must regenerate verification metadata:

./gradlew --write-verification-metadata pgp,sha256 --export-keys help

This updates both gradle/verification-metadata.xml (trusted keys) and gradle/verification-keyring.keys (PGP keyring). Commit both files.

Rundeck X.Y.Z-SNAPSHOT: If that command fails with Multiple entries with same key for org.rundeck:rundeck-authz-*, Gradle merged two different snapshot builds in one run. Use one of these approaches:

1. Temporarily set rundeck in gradle/libs.versions.toml to a released version on Maven Central (see org.rundeck:rundeck-authz-core there), run the command above, then restore X.Y.Z-SNAPSHOT and re-apply the Sonatype snapshot checksum blocks for the authz JARs/modules (or copy them from a prior commit).
2. Add or adjust checksums and trusted keys by hand for the new snapshot build, using artifacts from Sonatype snapshots.

Refresh Dependency Verification Keys

After a failed build.

./gradlew --write-verification-metadata pgp,sha256 --refresh-keys --export-keys help

Install Locally

Install to local path rd-cli-tool/build/install/rd/bin/rd

./gradlew :rd-cli-tool:installDist

Local Run

Run local installation at path rd-cli-tool/build/install/rd/bin/rd

./rd-cli-tool/build/install/rd/bin/rd "${@}"

Release

Release a new version

Uses axion release plugin.

./gradlew release

Release using Snapshots

If you need to release with any SNAPSHOT dependency Otherwise, axion-release will fail the prerelease check. Only do this for testing.

./gradlew release -Prelease.disableChecks

Next Minor Version

Updates minor version without releasing, e.g. 0.1.x-SNAPSHOT becomes 0.2.0-SNAPSHOT

./gradlew markNextVersion -Prelease.incrementer=incrementMinor

Release Force version

Release and force a particular version

./gradlew release -Prelease.forceVersion=${1:?version argument must be specified}