https://github.com/rundeck/rundeck-cli
CLI tool for Rundeck
https://github.com/rundeck/rundeck-cli
api category-distributed cli client command-line java rundeck tool
Last synced: 16 days ago
JSON representation
CLI tool for Rundeck
- Host: GitHub
- URL: https://github.com/rundeck/rundeck-cli
- Owner: rundeck
- License: apache-2.0
- Created: 2016-06-01T19:11:39.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2026-04-07T04:12:48.000Z (16 days ago)
- Last Synced: 2026-04-07T04:29:04.437Z (16 days ago)
- Topics: api, category-distributed, cli, client, command-line, java, rundeck, tool
- Language: Java
- Homepage: https://rundeck.github.io/rundeck-cli/
- Size: 4.31 MB
- Stars: 139
- Watchers: 19
- Forks: 47
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Rundeck CLI Tool
[](https://travis-ci.org/rundeck/rundeck-cli)
This is the official CLI tool for [Rundeck](https://github.com/rundeck/rundeck).
# Documentation
[https://rundeck.github.io/rundeck-cli/](https://rundeck.github.io/rundeck-cli/)
* [Changelog](https://rundeck.github.io/rundeck-cli/changes/)
* [Install](https://docs.rundeck.com/docs/rd-cli/install.html)
* [Configuration](https://docs.rundeck.com/docs/rd-cli/configuration.html)
* [SSL Configuration](https://docs.rundeck.com/docs/rd-cli/configuration.html#ssl-configuration)
* [Commands](https://docs.rundeck.com/docs/rd-cli/commands.html)
* [Scripting](https://docs.rundeck.com/docs/rd-cli/scripting.html)
* [Java API Library](https://docs.rundeck.com/docs/rd-cli/javalib.html)
* [Extensions](https://docs.rundeck.com/docs/rd-cli/extensions.html)
## Bundled Extensions
* [rd acl](https://rundeck.github.io/rd-ext-acl/) - Test and generate Rundeck ACL policy files
# Javadoc
* [rd-api-client ](https://javadoc.io/doc/org.rundeck.api/rd-api-client)
* [rd-cli-lib ](https://javadoc.io/doc/org.rundeck.cli/rd-cli-lib)
# Downloads
[Github Releases](https://github.com/rundeck/rundeck-cli/releases)
For apt and yum repos, see [Install](https://docs.rundeck.com/docs/rd-cli/install.html)
# 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 by Renovate when dependencies change.
**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.
## 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](https://axion-release-plugin.readthedocs.io/en/latest/) 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}